Andrew Godwin
827d5dc189
Improve docs around deconstruction/serialisation (refs #22337)
|
11 years ago | |
|---|---|---|
| .. | ||
| _ext | 11 years ago | |
| _theme | 11 years ago | |
| faq | 11 years ago | |
| howto | 11 years ago | |
| internals | 11 years ago | |
| intro | 11 years ago | |
| man | 11 years ago | |
| misc | 11 years ago | |
| ref | 11 years ago | |
| releases | 11 years ago | |
| topics | 11 years ago | |
| Makefile | 11 years ago | |
| README | 11 years ago | |
| conf.py | 11 years ago | |
| contents.txt | 12 years ago | |
| glossary.txt | 11 years ago | |
| index.txt | 11 years ago | |
| make.bat | 12 years ago | |
| spelling_wordlist | 11 years ago | |
README
The documentation in this tree is in plain text files and can be viewed using
any text file viewer.
It uses ReST (reStructuredText) [1], and the Sphinx documentation system [2].
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 ``sudo 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.
[1] http://docutils.sourceforge.net/rst.html
[2] http://sphinx-doc.org/
any text file viewer.
It uses ReST (reStructuredText) [1], and the Sphinx documentation system [2].
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 ``sudo 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.
[1] http://docutils.sourceforge.net/rst.html
[2] http://sphinx-doc.org/