/docs/README

https://code.google.com/p/mango-py/ · #! · 17 lines · 11 code · 6 blank · 0 comment · 0 complexity · b2bdd0e6b4c3764dcd3da212596c7ec7 MD5 · raw file 

    

  1. The documentation in this tree is in plain text files and can be viewed using
    2. 

  2. any text file viewer.
    3. 

  3. 

  4. Technically speaking, it uses ReST (reStructuredText) [1], and the Sphinx
    5. 

  5. documentation system [2].  This allows it to be built into other forms for
    6. 

  6. easier viewing and browsing.
    7. 

  7. 

  8. To create an HTML version of the docs on a Unix machine (Linux or Mac):
    9. 

  9. 

  10. * Install Sphinx (using ``easy_install Sphinx`` or some other method)
    11. 

  11. 

  12. * In this docs/ directory, type ``make html`` at a shell prompt.
    13. 

  13. 

  14. The documentation in _build/html/index.html can then be viewed in a web browser.
    15. 

  15. 

  16. [1] http://docutils.sourceforge.net/rst.html
    17. 

  17. [2] http://sphinx.pocoo.org/
    18.