Sergey Fursov
feeb0685c6
Updated example of YAML serialization format in docs.
|
3 years ago | |
|---|---|---|
| .. | ||
| _ext | 3 years ago | |
| _theme | 3 years ago | |
| faq | 3 years ago | |
| howto | 3 years ago | |
| internals | 3 years ago | |
| intro | 3 years ago | |
| man | 3 years ago | |
| misc | 3 years ago | |
| ref | 3 years ago | |
| releases | 3 years ago | |
| topics | 3 years ago | |
| Makefile | 7 years ago | |
| README.rst | 5 years ago | |
| conf.py | 3 years ago | |
| contents.txt | 9 years ago | |
| glossary.txt | 9 years ago | |
| index.txt | 3 years ago | |
| make.bat | 3 years ago | |
| requirements.txt | 3 years ago | |
| spelling_wordlist | 3 years 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/