From 6c9c823e7a58827af9f3127d884aef4ac0a7251e Mon Sep 17 00:00:00 2001 From: Someoneece <54041974+Someoneece@users.noreply.github.com> Date: Thu, 9 Jan 2020 03:36:55 +0530 Subject: Renamed docs/README to README.rst. --- docs/README | 17 ----------------- docs/README.rst | 17 +++++++++++++++++ 2 files changed, 17 insertions(+), 17 deletions(-) delete mode 100644 docs/README create mode 100644 docs/README.rst (limited to 'docs') diff --git a/docs/README b/docs/README deleted file mode 100644 index f34aa8782a..0000000000 --- a/docs/README +++ /dev/null @@ -1,17 +0,0 @@ -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/ 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/ -- cgit v1.3