Adam Johnson
971a84d6af
Clarified AppConfig.ready() docs example.
|
vor 5 Jahren | |
|---|---|---|
| .. | ||
| _ext | vor 5 Jahren | |
| _theme | vor 5 Jahren | |
| faq | vor 5 Jahren | |
| howto | vor 5 Jahren | |
| internals | vor 5 Jahren | |
| intro | vor 5 Jahren | |
| man | vor 5 Jahren | |
| misc | vor 5 Jahren | |
| ref | vor 5 Jahren | |
| releases | vor 5 Jahren | |
| topics | vor 5 Jahren | |
| Makefile | vor 7 Jahren | |
| README.rst | vor 5 Jahren | |
| conf.py | vor 5 Jahren | |
| contents.txt | vor 9 Jahren | |
| glossary.txt | vor 9 Jahren | |
| index.txt | vor 5 Jahren | |
| make.bat | vor 12 Jahren | |
| spelling_wordlist | vor 5 Jahren | |
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: http://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: http://sphinx-doc.org