README.rst 655 B

123456789101112131415161718
  1. The documentation in this tree is in plain text files and can be viewed using
  2. any text file viewer.
  3. It uses `ReST`_ (reStructuredText), and the `Sphinx`_ documentation system.
  4. This allows it to be built into other forms for easier viewing and browsing.
  5. To create an HTML version of the docs:
  6. * Install Sphinx (using ``python -m pip install Sphinx`` or some other method).
  7. * In this docs/ directory, type ``make html`` (or ``make.bat html`` on
  8. Windows) at a shell prompt.
  9. The documentation in ``_build/html/index.html`` can then be viewed in a web
  10. browser.
  11. .. _ReST: https://docutils.sourceforge.io/rst.html
  12. .. _Sphinx: https://www.sphinx-doc.org/