ead9085f08
* Added headers emphasising Work on the framework vs Join the community sections, to raise the visibility of the community section. * Added callouts to three main code/docs/translations areas, linking to respective start pages. * Moved some Writing code specific content from the start page to the Writing code index. This clarifies the start page and adds content to the previously empty Writing code index. Co-authored-by: Carlton Gibson <carlton.gibson@noumenal.es> |
||
|---|---|---|
| .. | ||
| _ext | ||
| _theme | ||
| faq | ||
| howto | ||
| internals | ||
| intro | ||
| man | ||
| misc | ||
| ref | ||
| releases | ||
| topics | ||
| Makefile | ||
| README.rst | ||
| conf.py | ||
| contents.txt | ||
| glossary.txt | ||
| index.txt | ||
| make.bat | ||
| requirements.txt | ||
| spelling_wordlist | ||
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/