|
@@ -1,7 +1,7 @@
|
|
|
The documentation in this tree is in plain text files and can be viewed using
|
|
The documentation in this tree is in plain text files and can be viewed using
|
|
|
any text file viewer.
|
|
any text file viewer.
|
|
|
|
|
|
|
|
-It uses ReST (reStructuredText) [1], and the Sphinx documentation system [2].
|
|
+It uses `ReST`_ (reStructuredText), and the `Sphinx`_ documentation system.
|
|
|
This allows it to be built into other forms for easier viewing and browsing.
|
|
This allows it to be built into other forms for easier viewing and browsing.
|
|
|
|
|
|
|
|
To create an HTML version of the docs:
|
|
To create an HTML version of the docs:
|
|
@@ -11,7 +11,8 @@ To create an HTML version of the docs:
|
|
|
* In this docs/ directory, type ``make html`` (or ``make.bat html`` on
|
|
* In this docs/ directory, type ``make html`` (or ``make.bat html`` on
|
|
|
Windows) at a shell prompt.
|
|
Windows) at a shell prompt.
|
|
|
|
|
|
|
|
-The documentation in _build/html/index.html can then be viewed in a web browser.
|
|
+The documentation in ``_build/html/index.html`` can then be viewed in a web
|
|
|
|
|
+browser.
|
|
|
|
|
|
|
|
-[1] http://docutils.sourceforge.net/rst.html
|
|
+.. _ReST: https://docutils.sourceforge.io/rst.html
|
|
|
-[2] http://sphinx-doc.org/
|
|
+.. _Sphinx: http://sphinx-doc.org
|
KHMANJUNATH