Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Convert READMEs to rst #5

Closed
wants to merge 12 commits into from
Prev Previous commit
Next Next commit
Doc/README.rst
kirbyfan64 authored Feb 10, 2017
commit 68beeb36be1e593a31dabfa24a853e4adbc26ba4
30 changes: 15 additions & 15 deletions Doc/README.rst
Original file line number Diff line number Diff line change
@@ -43,52 +43,52 @@ the SPHINXBUILD variable.

Available make targets are:

* "clean", which removes all build files.
* *clean*, which removes all build files.

* "html", which builds standalone HTML files for offline viewing.
* *html*, which builds standalone HTML files for offline viewing.

* "htmlview", which re-uses the "html" builder, but then opens the main page
* *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
* *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
* *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.
* *text*, which builds a plain text file for each source file.

* "epub", which builds an EPUB document, suitable to be viewed on e-book
* *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
* *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/
* *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
* *coverage*, which builds a coverage overview for standard library modules and
C API.

* "pydoc-topics", which builds a Python module containing a dictionary with
* *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
* *suspicious*, which checks the parsed markup for text that looks like
malformed and thus unconverted reST.

* "check", which checks for frequent markup errors.
* *check*, which checks for frequent markup errors.

* "serve", which serves the build/html directory on port 8000.
* *serve*, which serves the build/html directory on port 8000.

* "dist", (Unix only) which creates distributable archives of HTML, text,
* *dist*, (Unix only) which creates distributable archives of HTML, text,
PDF, and EPUB builds.