| Server IP : 127.0.0.2 / Your IP : 3.16.10.2 Web Server : Apache/2.4.18 (Ubuntu) System : User : www-data ( ) PHP Version : 7.0.33-0ubuntu0.16.04.16 Disable Function : disk_free_space,disk_total_space,diskfreespace,dl,exec,fpaththru,getmyuid,getmypid,highlight_file,ignore_user_abord,leak,listen,link,opcache_get_configuration,opcache_get_status,passthru,pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,php_uname,phpinfo,posix_ctermid,posix_getcwd,posix_getegid,posix_geteuid,posix_getgid,posix_getgrgid,posix_getgrnam,posix_getgroups,posix_getlogin,posix_getpgid,posix_getpgrp,posix_getpid,posix,_getppid,posix_getpwnam,posix_getpwuid,posix_getrlimit,posix_getsid,posix_getuid,posix_isatty,posix_kill,posix_mkfifo,posix_setegid,posix_seteuid,posix_setgid,posix_setpgid,posix_setsid,posix_setuid,posix_times,posix_ttyname,posix_uname,pclose,popen,proc_open,proc_close,proc_get_status,proc_nice,proc_terminate,shell_exec,source,show_source,system,virtual MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : ON | Pkexec : ON Directory : /usr/share/doc/docutils-doc/ |
Upload File : |
<?xml version="1.0" encoding="utf-8" ?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta name="generator" content="Docutils 0.12: http://docutils.sourceforge.net/" /> <title>README: Docutils 0.12</title> <meta name="author" content="David Goodger" /> <meta name="date" content="2013-07-22" /> <meta name="copyright" content="This document has been placed in the public domain." /> <link rel="stylesheet" href="css/html4css1.css" type="text/css" /> </head> <body> <div class="document" id="readme-docutils-0-12"> <h1 class="title">README: Docutils 0.12</h1> <table class="docinfo" frame="void" rules="none"> <col class="docinfo-name" /> <col class="docinfo-content" /> <tbody valign="top"> <tr><th class="docinfo-name">Author:</th> <td>David Goodger</td></tr> <tr><th class="docinfo-name">Contact:</th> <td><a class="first last reference external" href="mailto:goodger@python.org">goodger@python.org</a></td></tr> <tr><th class="docinfo-name">Date:</th> <td>2013-07-22</td></tr> <tr class="field"><th class="docinfo-name">Web site:</th><td class="field-body"><a class="reference external" href="http://docutils.sourceforge.net/">http://docutils.sourceforge.net/</a></td> </tr> <tr><th class="docinfo-name">Copyright:</th> <td>This document has been placed in the public domain.</td></tr> </tbody> </table> <div class="contents topic" id="contents"> <p class="topic-title first">Contents</p> <ul class="simple"> <li><a class="reference internal" href="#quick-start-on-debian-systems" id="id1">Quick-Start on Debian systems</a></li> <li><a class="reference internal" href="#quick-start-on-other-systems" id="id2">Quick-Start on other systems</a></li> <li><a class="reference internal" href="#purpose" id="id3">Purpose</a></li> <li><a class="reference internal" href="#releases-snapshots" id="id4">Releases & Snapshots</a></li> <li><a class="reference internal" href="#requirements" id="id5">Requirements</a><ul> <li><a class="reference internal" href="#python-3-compatibility" id="id6">Python 3 compatibility</a></li> </ul> </li> <li><a class="reference internal" href="#project-files-directories" id="id7">Project Files & Directories</a></li> <li><a class="reference internal" href="#installation" id="id8">Installation</a><ul> <li><a class="reference internal" href="#gnu-linux-bsds-unix-mac-os-x-etc" id="id9">GNU/Linux, BSDs, Unix, Mac OS X, etc.</a></li> <li><a class="reference internal" href="#windows" id="id10">Windows</a></li> </ul> </li> <li><a class="reference internal" href="#usage" id="id11">Usage</a></li> <li><a class="reference internal" href="#converting-the-documentation" id="id12">Converting the documentation</a></li> <li><a class="reference internal" href="#running-the-test-suite" id="id13">Running the Test Suite</a></li> <li><a class="reference internal" href="#getting-help" id="id14">Getting Help</a></li> </ul> </div> <div class="section" id="quick-start-on-debian-systems"> <h1><a class="toc-backref" href="#id1">Quick-Start on Debian systems</a></h1> <p>The reStructuredText tools are installed in the normal system path by the Debian <tt class="docutils literal"><span class="pre">python-docutils</span></tt> package. To convert reStructuredText to another format, use a shell command like:</p> <pre class="literal-block"> rst2html /usr/share/doc/python-docutils/FAQ.txt ./FAQ.html </pre> <p>See <a class="reference internal" href="#usage">Usage</a> below for details.</p> </div> <div class="section" id="quick-start-on-other-systems"> <h1><a class="toc-backref" href="#id2">Quick-Start on other systems</a></h1> <p>This is for those who want to get up & running quickly.</p> <ol class="arabic"> <li><p class="first">Docutils requires Python (version 2.4 or later), available from</p> <blockquote> <p><a class="reference external" href="http://www.python.org/">http://www.python.org/</a></p> </blockquote> <p>See <a class="reference internal" href="#requirements">Requirements</a> below for details.</p> </li> <li><p class="first">Use the latest Docutils code. Get the code from the <a class="reference external" href="docs/dev/repository.html">Subversion repository</a> or from the snapshot:</p> <blockquote> <p><a class="reference external" href="http://docutils.svn.sourceforge.net/viewvc/docutils/trunk/docutils/?view=tar">http://docutils.svn.sourceforge.net/viewvc/docutils/trunk/docutils/?view=tar</a></p> </blockquote> <p>See <a class="reference internal" href="#releases-snapshots">Releases & Snapshots</a> below for details.</p> </li> <li><p class="first">Unpack the tarball in a temporary directory (<strong>not</strong> directly in Python's <tt class="docutils literal"><span class="pre">site-packages</span></tt>), go to the directory created by expanding the archive, and run <tt class="docutils literal">setup.py install</tt> with admin rights. On Windows systems it may be sufficient to double-click <tt class="docutils literal">install.py</tt>.</p> <p>See <a class="reference internal" href="#installation">Installation</a> below for details.</p> </li> <li><p class="first">Use the front-end scripts to convert reStructuredText documents. Try for example:</p> <pre class="literal-block"> rst2html.py FAQ.txt FAQ.html (Unix) python tools/rst2html.py FAQ.txt FAQ.html (Windows) </pre> <p>See <a class="reference internal" href="#usage">Usage</a> below for details.</p> </li> </ol> </div> <div class="section" id="purpose"> <h1><a class="toc-backref" href="#id3">Purpose</a></h1> <p>The purpose of the Docutils project is to create a set of tools for processing plaintext documentation into useful formats, such as HTML, XML, and LaTeX. Support for the following sources has been implemented:</p> <ul class="simple"> <li>Standalone files.</li> <li><a class="reference external" href="http://www.python.org/peps/pep-0012.html">PEPs (Python Enhancement Proposals)</a>.</li> </ul> <p>Support for the following sources is planned:</p> <ul class="simple"> <li>Inline documentation from Python modules and packages, extracted with namespace context.</li> <li>Email (RFC-822 headers, quoted excerpts, signatures, MIME parts).</li> <li>Wikis, with global reference lookups of "wiki links".</li> <li>Compound documents, such as multiple chapter files merged into a book.</li> <li>And others as discovered.</li> </ul> </div> <div class="section" id="releases-snapshots"> <h1><a class="toc-backref" href="#id4">Releases & Snapshots</a></h1> <p>While we are trying to follow a "release early & often" policy, features are added very frequently. Since the code in the Subversion repository is usually in a bug-free state, we recommend that you use the current snapshot (which is usually updated within an hour of changes being committed to the repository):</p> <ul class="simple"> <li>Snapshot of Docutils code, documentation, front-end tools, and tests: <a class="reference external" href="http://docutils.svn.sourceforge.net/viewvc/docutils/trunk/docutils/?view=tar">http://docutils.svn.sourceforge.net/viewvc/docutils/trunk/docutils/?view=tar</a></li> <li>Snapshot of the Sandbox (experimental, contributed code): <a class="reference external" href="http://docutils.svn.sourceforge.net/viewvc/docutils/trunk/sandbox/?view=tar">http://docutils.svn.sourceforge.net/viewvc/docutils/trunk/sandbox/?view=tar</a></li> </ul> <p>To keep up to date on the latest developments, download fresh copies of the snapshots regularly or use a working copy of the <a class="reference external" href="docs/dev/repository.html">Subversion repository</a>.</p> </div> <div class="section" id="requirements"> <h1><a class="toc-backref" href="#id5">Requirements</a></h1> <p>To run the code, <a class="reference external" href="http://www.python.org/.">Python</a> must be installed. Docutils is compatible with Python versions from 2.4 up to 2.7 and versions 3.1 and 3.2 (cf. <a class="reference internal" href="#python-3-compatibility">Python 3 compatibility</a>).</p> <p>Docutils uses the following packages for enhanced functionality, if they are installed:</p> <ul class="simple"> <li>The <a class="reference external" href="http://www.pythonware.com/products/pil/">Python Imaging Library</a>, or PIL, is used for some image manipulation operations.</li> <li>The <a class="reference external" href="http://pygments.org/">Pygments</a> syntax highlighter is used for content of <cite>code</cite> directives and roles.</li> </ul> <div class="section" id="python-3-compatibility"> <h2><a class="toc-backref" href="#id6">Python 3 compatibility</a></h2> <p>The Docutils codebase is written for Python 2 and uses "on-demand" translation for <a class="reference external" href="http://docs.python.org/py3k/howto/pyporting.html">porting to Python 3</a>.</p> <ul class="simple"> <li>The <cite>setup.py</cite> script generates Python 3 compatible sources in <tt class="docutils literal">build/</tt> and tests in <tt class="docutils literal">tests3/</tt> sub-directories during <a class="reference internal" href="#installation">installation</a> with Python 3.</li> <li>The scripts in the <tt class="docutils literal">tools/</tt> sub-directory work with all supported Python versions without conversion.</li> <li>To convert the sources without installing (e.g. for testing), run <tt class="docutils literal">python3 setup.py build</tt>.</li> <li>When editing the source, do changes on the Python 2 versions of the files and re-run the build command.</li> </ul> <p>Using Docutils with Python 3.x is less tested and might still have some issues.</p> </div> </div> <div class="section" id="project-files-directories"> <h1><a class="toc-backref" href="#id7">Project Files & Directories</a></h1> <ul class="simple"> <li>README.txt: You're reading it.</li> <li>COPYING.txt: Public Domain Dedication and copyright details for non-public-domain files (most are PD).</li> <li>FAQ.txt: Frequently Asked Questions (with answers!).</li> <li>RELEASE-NOTES.txt: Summary of the major changes in recent releases.</li> <li>HISTORY.txt: A detailed change log, for the current and all previous project releases.</li> <li>BUGS.txt: Known bugs, and how to report a bug.</li> <li>THANKS.txt: List of contributors.</li> <li>setup.py: Installation script. See "Installation" below.</li> <li>install.py: Quick & dirty installation script. Just run it. For any kind of customization or help though, setup.py must be used.</li> <li>docutils: The project source directory, installed as a Python package.</li> <li>docs: The project documentation directory. Read <tt class="docutils literal">docs/index.txt</tt> for an overview.</li> <li>docs/user: The project user documentation directory. Contains the following documents, among others:<ul> <li>docs/user/tools.txt: Docutils Front-End Tools</li> <li>docs/user/latex.txt: Docutils LaTeX Writer</li> <li>docs/user/rst/quickstart.txt: A ReStructuredText Primer</li> <li>docs/user/rst/quickref.html: Quick reStructuredText (HTML only)</li> </ul> </li> <li>docs/ref: The project reference directory. <tt class="docutils literal">docs/ref/rst/restructuredtext.txt</tt> is the reStructuredText reference.</li> <li>licenses: Directory containing copies of license files for non-public-domain files.</li> <li>tools: Directory for Docutils front-end tools. See <tt class="docutils literal">docs/user/tools.txt</tt> for documentation.</li> <li>test: Unit tests. Not required to use the software, but very useful if you're planning to modify it. See <a class="reference internal" href="#running-the-test-suite">Running the Test Suite</a> below.</li> </ul> <p>Generated directories when installing under Python 3:</p> <ul class="simple"> <li>build: Converted sources.</li> <li>test3: Converted tests.</li> </ul> </div> <div class="section" id="installation"> <h1><a class="toc-backref" href="#id8">Installation</a></h1> <p>The first step is to expand the <tt class="docutils literal">.tgz</tt> archive in a temporary directory (<strong>not</strong> directly in Python's <tt class="docutils literal"><span class="pre">site-packages</span></tt>). It contains a distutils setup file "setup.py". OS-specific installation instructions follow.</p> <div class="section" id="gnu-linux-bsds-unix-mac-os-x-etc"> <h2><a class="toc-backref" href="#id9">GNU/Linux, BSDs, Unix, Mac OS X, etc.</a></h2> <ol class="arabic"> <li><p class="first">Open a shell.</p> </li> <li><p class="first">Go to the directory created by expanding the archive:</p> <pre class="literal-block"> cd <archive_directory_path> </pre> </li> <li><p class="first">Install the package (you may need root permissions to complete this step):</p> <pre class="literal-block"> su (enter admin password) python setup.py install </pre> <p>If the python executable isn't on your path, you'll have to specify the complete path, such as <tt class="docutils literal">/usr/local/bin/python</tt>.</p> <p>To install for a specific Python version, use this version in the setup call, e.g.</p> <pre class="literal-block"> python3.1 setup.py install </pre> <p>To install for different Python versions, repeat step 3 for every required version. The last installed version will be used in the <a class="reference external" href="http://en.wikipedia.org/wiki/Shebang_%28Unix%29">shebang line</a> of the <tt class="docutils literal"><span class="pre">rst2*.py</span></tt> wrapper scripts.</p> </li> </ol> </div> <div class="section" id="windows"> <h2><a class="toc-backref" href="#id10">Windows</a></h2> <p>Just double-click <tt class="docutils literal">install.py</tt>. If this doesn't work, try the following:</p> <ol class="arabic"> <li><p class="first">Open a DOS Box (Command Shell, MS-DOS Prompt, or whatever they're calling it these days).</p> </li> <li><p class="first">Go to the directory created by expanding the archive:</p> <pre class="literal-block"> cd <archive_directory_path> </pre> </li> <li><p class="first">Install the package:</p> <pre class="literal-block"> <path_to_python.exe>\python setup.py install </pre> <p>To install for a specific python version, specify the Python executable for this version.</p> <p>To install for different Python versions, repeat step 3 for every required version.</p> </li> </ol> <p>Optional steps:</p> <ul class="simple"> <li><a class="reference internal" href="#running-the-test-suite">running the test suite</a></li> <li><a class="reference internal" href="#converting-the-documentation">converting the documentation</a></li> </ul> </div> </div> <div class="section" id="usage"> <h1><a class="toc-backref" href="#id11">Usage</a></h1> <p>There are many front-end tools in the unpacked "tools" subdirectory. Installation under Unix places copies in the PATH. You may want to begin with the "rst2html.py" front-end tool. Most tools take up to two arguments, the source path and destination path, with STDIN and STDOUT being the defaults. Use the "--help" option to the front-end tools for details on options and arguments. See Docutils Front-End Tools (<tt class="docutils literal">docs/user/tools.txt</tt>) for full documentation.</p> <p>On a Debian system the included tools (with the exception of quicktest.py and the development tools in the dev/ directory) are installed into the normal system path, so you can run <tt class="docutils literal">rst2html.py</tt> with a command like:</p> <pre class="literal-block"> rst2html example.txt example.html </pre> <p>The package modules are continually growing and evolving. The <tt class="docutils literal">docutils.statemachine</tt> module is usable independently. It contains extensive inline documentation (in reStructuredText format of course).</p> <p>Contributions are welcome!</p> </div> <div class="section" id="converting-the-documentation"> <h1><a class="toc-backref" href="#id12">Converting the documentation</a></h1> <p>After unpacking and installing the Docutils package, the following shell commands will generate HTML for all included documentation:</p> <pre class="literal-block"> cd <archive_directory_path>/tools ./buildhtml.py ../ </pre> <p>On Windows systems, type:</p> <pre class="literal-block"> cd <archive_directory_path>\tools python buildhtml.py .. </pre> <p>The final directory name of the <tt class="docutils literal"><archive_directory_path></tt> is "docutils" for snapshots. For official releases, the directory may be called "docutils-X.Y.Z", where "X.Y.Z" is the release version. Alternatively:</p> <pre class="literal-block"> cd <archive_directory_path> tools/buildhtml.py --config=tools/docutils.conf (Unix) python tools\buildhtml.py --config=tools\docutils.conf (Windows) </pre> <p>Some files may generate system messages (warnings and errors). The <tt class="docutils literal">docs/user/rst/demo.txt</tt> file (under the archive directory) contains five intentional errors. (They test the error reporting mechanism!)</p> </div> <div class="section" id="running-the-test-suite"> <h1><a class="toc-backref" href="#id13">Running the Test Suite</a></h1> <p>The test suite is documented in <a class="reference external" href="http://docutils.sourceforge.net/docs/dev/testing.html">Docutils Testing</a> (docs/dev/testing.txt).</p> <p>To run the entire test suite, open a shell and use the following commands:</p> <pre class="literal-block"> cd <archive_directory_path>/test ./alltests.py </pre> <p>Under Windows, type:</p> <pre class="literal-block"> cd <archive_directory_path>\test python alltests.py </pre> <p>For testing with Python 3 use the converted test suite:</p> <pre class="literal-block"> cd <archive_directory_path>/test3 python3 alltests.py </pre> <p>You should see a long line of periods, one for each test, and then a summary like this:</p> <pre class="literal-block"> Ran 1111 tests in 24.653s OK Elapsed time: 26.189 seconds </pre> <p>The number of tests will grow over time, and the times reported will depend on the computer running the tests. The difference between the two times represents the time required to set up the tests (import modules, create data structures, etc.).</p> <p>If any of the tests fail, please <a class="reference external" href="http://sourceforge.net/tracker/?group_id=38414&atid=422030">open a bug report</a>, <a class="reference external" href="mailto:docutils-users@lists.sourceforge.net?subject=Test%20suite%20failure">send email</a>, or post a message via the <a class="reference external" href="http://post.gmane.org/post.php?group=gmane.text.docutils.user&subject=Test+suite+failure">web interface</a> (see <a class="reference external" href="BUGS.html">Bugs</a>). Please include all relevant output, information about your operating system, Python version, and Docutils version. To see the Docutils version, use one of the <tt class="docutils literal">rst2*</tt> front ends or <tt class="docutils literal">tools/quicktest.py</tt> with the <tt class="docutils literal"><span class="pre">--version</span></tt> option, e.g.:</p> <pre class="literal-block"> cd ../tools ./quicktest.py --version </pre> <p>Windows users type these commands:</p> <pre class="literal-block"> cd ..\tools python quicktest.py --version </pre> </div> <div class="section" id="getting-help"> <h1><a class="toc-backref" href="#id14">Getting Help</a></h1> <p>If you have questions or need assistance with Docutils or reStructuredText, please post a message to the <a class="reference external" href="docs/user/mailing-lists.html#docutils-users">Docutils-users</a> mailing list.</p> <!-- Local Variables: mode: indented-text indent-tabs-mode: nil sentence-end-double-space: t fill-column: 70 End: --> </div> </div> </body> </html>