diff options
| author | KHMANJUNATH <KHMANJUNATH447@GMAIL.COM> | 2020-01-09 18:40:28 +0530 |
|---|---|---|
| committer | Mariusz Felisiak <felisiak.mariusz@gmail.com> | 2020-01-09 14:10:27 +0100 |
| commit | ceecd0556dc6f013b5b62fedb12453b8ae3b8067 (patch) | |
| tree | 7d27672a888087b9be785a59e8c450b7ef4b47e7 /docs | |
| parent | eef3ea847e12f23db9a0af8efdc9543f24b780c4 (diff) | |
Improved ReST formatting in docs/README.rst.
Co-authored-by: Mariusz Felisiak <felisiak.mariusz@gmail.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/README.rst | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/docs/README.rst b/docs/README.rst index f34aa8782a..c9ed46ddfc 100644 --- a/docs/README.rst +++ b/docs/README.rst @@ -1,7 +1,7 @@ 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]. +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: @@ -11,7 +11,8 @@ To create an HTML version of the docs: * 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. +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/ +.. _ReST: https://docutils.sourceforge.io/rst.html +.. _Sphinx: http://sphinx-doc.org |