diff options
| author | Someoneece <54041974+Someoneece@users.noreply.github.com> | 2020-01-09 03:36:55 +0530 |
|---|---|---|
| committer | Mariusz Felisiak <felisiak.mariusz@gmail.com> | 2020-01-09 08:18:44 +0100 |
| commit | 6c9c823e7a58827af9f3127d884aef4ac0a7251e (patch) | |
| tree | b86894413c9e0db9710f9b7f42998237eec33f08 /docs/README.rst | |
| parent | 0707ff6d366de6fbe08c8f70dd9d483344077711 (diff) | |
Renamed docs/README to README.rst.
Diffstat (limited to 'docs/README.rst')
| -rw-r--r-- | docs/README.rst | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/README.rst b/docs/README.rst new file mode 100644 index 0000000000..f34aa8782a --- /dev/null +++ b/docs/README.rst @@ -0,0 +1,17 @@ +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 ``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. + +[1] http://docutils.sourceforge.net/rst.html +[2] http://sphinx-doc.org/ |