Maryam Yusuf
438fc42ac6
Expanded contributor docs on getting feedback from the wider community.
|
před 2 měsíci | |
|---|---|---|
| .. | ||
| _ext | před 3 měsíci | |
| _theme | před 2 roky | |
| faq | před 1 týdnem | |
| howto | před 1 týdnem | |
| internals | před 7 hodinami | |
| intro | před 1 týdnem | |
| man | před 4 měsíci | |
| misc | před 8 měsíci | |
| ref | před 8 hodinami | |
| releases | před 8 hodinami | |
| topics | před 1 dnem | |
| Makefile | před 1 rokem | |
| README.rst | před 4 roky | |
| conf.py | před 5 dny | |
| contents.txt | před 8 roky | |
| glossary.txt | před 8 roky | |
| index.txt | před 4 měsíci | |
| make.bat | před 1 rokem | |
| requirements.txt | před 1 rokem | |
| spelling_wordlist | před 7 hodinami | |
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/