Maryam Yusuf
438fc42ac6
Expanded contributor docs on getting feedback from the wider community.
|
2 months ago | |
|---|---|---|
| .. | ||
| _ext | 3 months ago | |
| _theme | 2 years ago | |
| faq | 1 week ago | |
| howto | 1 week ago | |
| internals | 13 hours ago | |
| intro | 1 week ago | |
| man | 4 months ago | |
| misc | 8 months ago | |
| ref | 14 hours ago | |
| releases | 14 hours ago | |
| topics | 1 day ago | |
| Makefile | 1 year ago | |
| README.rst | 4 years ago | |
| conf.py | 5 days ago | |
| contents.txt | 8 years ago | |
| glossary.txt | 8 years ago | |
| index.txt | 4 months ago | |
| make.bat | 1 year ago | |
| requirements.txt | 1 year ago | |
| spelling_wordlist | 13 hours ago | |
README.rst
The documentation in this tree is in plain text files and can be viewed using
any text file viewer.
It uses `ReST`_ (reStructuredText), and the `Sphinx`_ documentation system.
This allows it to be built into other forms for easier viewing and browsing.
To create an HTML version of the docs:
* Install Sphinx (using ``python -m pip install Sphinx`` or some other method).
* In this docs/ directory, type ``make html`` (or ``make.bat html`` on
Windows) at a shell prompt.
The documentation in ``_build/html/index.html`` can then be viewed in a web
browser.
.. _ReST: https://docutils.sourceforge.io/rst.html
.. _Sphinx: https://www.sphinx-doc.org/
any text file viewer.
It uses `ReST`_ (reStructuredText), and the `Sphinx`_ documentation system.
This allows it to be built into other forms for easier viewing and browsing.
To create an HTML version of the docs:
* Install Sphinx (using ``python -m pip install Sphinx`` or some other method).
* In this docs/ directory, type ``make html`` (or ``make.bat html`` on
Windows) at a shell prompt.
The documentation in ``_build/html/index.html`` can then be viewed in a web
browser.
.. _ReST: https://docutils.sourceforge.io/rst.html
.. _Sphinx: https://www.sphinx-doc.org/