From b3f1f59cf451d4a25b204e7a24f7be4c95e40be8 Mon Sep 17 00:00:00 2001 From: Roger Date: Wed, 15 Feb 2017 17:54:05 -0500 Subject: Rename Doc/README.txt to Doc/README.rst and add formatting (#104) * Reformat Doc/README.txt to Doc/README.rst * Update mention of Doc/README.rst * Update mention of README.txt to README.rst * Make line fold * rstlint ignore Doc/README.rst * conf.py ignore Doc/README.rst * Update issue tracker url in Docs/README.rst --- Doc/Makefile | 2 +- Doc/README.rst | 122 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Doc/README.txt | 121 -------------------------------------------------------- Doc/conf.py | 2 +- Doc/make.bat | 2 +- README.rst | 4 +- 6 files changed, 127 insertions(+), 126 deletions(-) create mode 100644 Doc/README.rst delete mode 100644 Doc/README.txt diff --git a/Doc/Makefile b/Doc/Makefile index eb62df5..94697f9 100644 --- a/Doc/Makefile +++ b/Doc/Makefile @@ -153,7 +153,7 @@ dist: cp -pPR build/epub/Python.epub dist/python-$(DISTVERSION)-docs.epub check: - $(PYTHON) tools/rstlint.py -i tools -i venv + $(PYTHON) tools/rstlint.py -i tools -i venv -i README.rst serve: ../Tools/scripts/serve.py build/html diff --git a/Doc/README.rst b/Doc/README.rst new file mode 100644 index 0000000..dcd3d6e --- /dev/null +++ b/Doc/README.rst @@ -0,0 +1,122 @@ +Python Documentation README +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This directory contains the reStructuredText (reST) sources to the Python +documentation. You don't need to build them yourself, `prebuilt versions are +available `_. + +Documentation on authoring Python documentation, including information about +both style and markup, is available in the "`Documenting Python +`_" chapter of the +developers guide. + + +Building the docs +================= + +You need to have `Sphinx `_ installed; it is the toolset +used to build the docs. It is not included in this tree, but maintained +separately and `available from PyPI `_. + + +Using make +---------- + +A Makefile has been prepared so that on Unix, provided you have installed +Sphinx, you can just run :: + + make html + +to build the HTML output files. + +On Windows, we try to emulate the Makefile as closely as possible with a +``make.bat`` file. + +To use a Python interpreter that's not called ``python``, use the standard +way to set Makefile variables, using e.g. :: + + make html PYTHON=python3 + +On Windows, set the PYTHON environment variable instead. + +To use a specific sphinx-build (something other than ``sphinx-build``), set +the SPHINXBUILD variable. + +Available make targets are: + +* "clean", which removes all build files. + +* "html", which builds standalone HTML files for offline viewing. + +* "htmlview", which re-uses the "html" builder, but then opens the main page + in your default web browser. + +* "htmlhelp", which builds HTML files and a HTML Help project file usable to + convert them into a single Compiled HTML (.chm) file -- these are popular + under Microsoft Windows, but very handy on every platform. + + To create the CHM file, you need to run the Microsoft HTML Help Workshop + over the generated project (.hhp) file. The make.bat script does this for + you on Windows. + +* "latex", which builds LaTeX source files as input to "pdflatex" to produce + PDF documents. + +* "text", which builds a plain text file for each source file. + +* "epub", which builds an EPUB document, suitable to be viewed on e-book + readers. + +* "linkcheck", which checks all external references to see whether they are + broken, redirected or malformed, and outputs this information to stdout as + well as a plain-text (.txt) file. + +* "changes", which builds an overview over all versionadded/versionchanged/ + deprecated items in the current version. This is meant as a help for the + writer of the "What's New" document. + +* "coverage", which builds a coverage overview for standard library modules and + C API. + +* "pydoc-topics", which builds a Python module containing a dictionary with + plain text documentation for the labels defined in + `tools/pyspecific.py` -- pydoc needs these to show topic and keyword help. + +* "suspicious", which checks the parsed markup for text that looks like + malformed and thus unconverted reST. + +* "check", which checks for frequent markup errors. + +* "serve", which serves the build/html directory on port 8000. + +* "dist", (Unix only) which creates distributable archives of HTML, text, + PDF, and EPUB builds. + + +Without make +------------ + +Install the Sphinx package and its dependencies from PyPI. + +Then, from the ``Doc`` directory, run :: + + sphinx-build -b . build/ + +where ```` is one of html, text, latex, or htmlhelp (for explanations +see the make targets above). + + +Contributing +============ + +Bugs in the content should be reported to the +`Python bug tracker `_. + +Bugs in the toolset should be reported in the +`Sphinx bug tracker `_. + +You can also send a mail to the Python Documentation Team at docs@python.org, +and we will process your request as soon as possible. + +If you want to help the Documentation Team, you are always welcome. Just send +a mail to docs@python.org. diff --git a/Doc/README.txt b/Doc/README.txt deleted file mode 100644 index 4f8e9f8..0000000 --- a/Doc/README.txt +++ /dev/null @@ -1,121 +0,0 @@ -Python Documentation README -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -This directory contains the reStructuredText (reST) sources to the Python -documentation. You don't need to build them yourself, prebuilt versions are -available at . - -Documentation on authoring Python documentation, including information about -both style and markup, is available in the "Documenting Python" chapter of the -developers guide . - - -Building the docs -================= - -You need to have Sphinx installed; it is the toolset -used to build the docs. It is not included in this tree, but maintained -separately and available from PyPI . - - -Using make ----------- - -A Makefile has been prepared so that on Unix, provided you have installed -Sphinx, you can just run :: - - make html - -to build the HTML output files. - -On Windows, we try to emulate the Makefile as closely as possible with a -``make.bat`` file. - -To use a Python interpreter that's not called ``python``, use the standard -way to set Makefile variables, using e.g. :: - - make html PYTHON=python3 - -On Windows, set the PYTHON environment variable instead. - -To use a specific sphinx-build (something other than ``sphinx-build``), set -the SPHINXBUILD variable. - -Available make targets are: - -* "clean", which removes all build files. - -* "html", which builds standalone HTML files for offline viewing. - -* "htmlview", which re-uses the "html" builder, but then opens the main page - in your default web browser. - -* "htmlhelp", which builds HTML files and a HTML Help project file usable to - convert them into a single Compiled HTML (.chm) file -- these are popular - under Microsoft Windows, but very handy on every platform. - - To create the CHM file, you need to run the Microsoft HTML Help Workshop - over the generated project (.hhp) file. The make.bat script does this for - you on Windows. - -* "latex", which builds LaTeX source files as input to "pdflatex" to produce - PDF documents. - -* "text", which builds a plain text file for each source file. - -* "epub", which builds an EPUB document, suitable to be viewed on e-book - readers. - -* "linkcheck", which checks all external references to see whether they are - broken, redirected or malformed, and outputs this information to stdout as - well as a plain-text (.txt) file. - -* "changes", which builds an overview over all versionadded/versionchanged/ - deprecated items in the current version. This is meant as a help for the - writer of the "What's New" document. - -* "coverage", which builds a coverage overview for standard library modules and - C API. - -* "pydoc-topics", which builds a Python module containing a dictionary with - plain text documentation for the labels defined in - `tools/pyspecific.py` -- pydoc needs these to show topic and keyword help. - -* "suspicious", which checks the parsed markup for text that looks like - malformed and thus unconverted reST. - -* "check", which checks for frequent markup errors. - -* "serve", which serves the build/html directory on port 8000. - -* "dist", (Unix only) which creates distributable archives of HTML, text, - PDF, and EPUB builds. - - -Without make ------------- - -Install the Sphinx package and its dependencies from PyPI. - -Then, from the ``Doc`` directory, run :: - - sphinx-build -b . build/ - -where ```` is one of html, text, latex, or htmlhelp (for explanations -see the make targets above). - - -Contributing -============ - -Bugs in the content should be reported to the Python bug tracker at -https://bugs.python.org. - -Bugs in the toolset should be reported in the Sphinx bug tracker at -https://www.bitbucket.org/birkenfeld/sphinx/issues/. - -You can also send a mail to the Python Documentation Team at docs@python.org, -and we will process your request as soon as possible. - -If you want to help the Documentation Team, you are always welcome. Just send -a mail to docs@python.org. diff --git a/Doc/conf.py b/Doc/conf.py index b3f26d5..18aebb6 100644 --- a/Doc/conf.py +++ b/Doc/conf.py @@ -37,7 +37,7 @@ highlight_language = 'python3' needs_sphinx = '1.2' # Ignore any .rst files in the venv/ directory. -exclude_patterns = ['venv/*'] +exclude_patterns = ['venv/*', 'README.rst'] # Options for HTML output diff --git a/Doc/make.bat b/Doc/make.bat index d0b5961..b1a3738 100644 --- a/Doc/make.bat +++ b/Doc/make.bat @@ -74,7 +74,7 @@ echo. Provided by this script: echo. clean, check, serve, htmlview echo. echo.All arguments past the first one are passed through to sphinx-build as -echo.filenames to build or are ignored. See README.txt in this directory or +echo.filenames to build or are ignored. See README.rst in this directory or echo.the documentation for your version of Sphinx for more exhaustive lists echo.of available targets and descriptions of each. echo. diff --git a/README.rst b/README.rst index c6cca80..652dfef 100644 --- a/README.rst +++ b/README.rst @@ -130,8 +130,8 @@ If you would like to contribute to the development of Python, relevant documentation is available in the `Python Developer's Guide `_. -For information about building Python's documentation, refer to `Doc/README.txt -`_. +For information about building Python's documentation, refer to `Doc/README.rst +`_. Converting From Python 2.x to 3.x -- cgit v0.12