Loading README +2 −0 Original line number Diff line number Diff line Loading @@ -17,6 +17,8 @@ how we recommend you read the docs: next; from there you can jump to the HOWTOs (in docs/howto) for specific problems, and check out the reference (docs/ref) for gory details. * See docs/README for instructions on building an HTML version of the docs. Docs are updated rigorously. If you find any problems in the docs, or think they should be clarified in any way, please take 30 seconds to fill out a ticket here: Loading docs/README 0 → 100644 +17 −0 Original line number Diff line number Diff line The documentation in this tree is in plain text files and can be viewed using any text file viewer. Technically speaking, it uses ReST (reStructuredText) [1], and the Sphinx documentation system [2]. This allows it to be built into other forms for easier viewing and browsing. To create an HTML version of the docs on a Unix machine (Linux or Mac): * Install Sphinx (using ``easy_install Sphinx`` or some other method) * In this docs/ directory, type ``make html`` at a shell prompt. The documentation in _build/html/index.html can then be viewed in a web browser. [1] http://docutils.sourceforge.net/rst.html [2] http://sphinx.pocoo.org/ Loading
README +2 −0 Original line number Diff line number Diff line Loading @@ -17,6 +17,8 @@ how we recommend you read the docs: next; from there you can jump to the HOWTOs (in docs/howto) for specific problems, and check out the reference (docs/ref) for gory details. * See docs/README for instructions on building an HTML version of the docs. Docs are updated rigorously. If you find any problems in the docs, or think they should be clarified in any way, please take 30 seconds to fill out a ticket here: Loading
docs/README 0 → 100644 +17 −0 Original line number Diff line number Diff line The documentation in this tree is in plain text files and can be viewed using any text file viewer. Technically speaking, it uses ReST (reStructuredText) [1], and the Sphinx documentation system [2]. This allows it to be built into other forms for easier viewing and browsing. To create an HTML version of the docs on a Unix machine (Linux or Mac): * Install Sphinx (using ``easy_install Sphinx`` or some other method) * In this docs/ directory, type ``make html`` at a shell prompt. The documentation in _build/html/index.html can then be viewed in a web browser. [1] http://docutils.sourceforge.net/rst.html [2] http://sphinx.pocoo.org/