p15693087
/
django
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Improved ReST formatting in docs/README.rst. 

Co-authored-by: Mariusz Felisiak <felisiak.mariusz@gmail.com>
This commit is contained in:
KHMANJUNATH 2020-01-09 18:40:28 +05:30 committed by Mariusz Felisiak
parent eef3ea847e
commit ceecd0556d
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/README.rst
View File

@ -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