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