Skip to content

Commit

Permalink
Reworded documentation of doc-gen configuration.
Browse files Browse the repository at this point in the history
  • Loading branch information
john-hen committed May 17, 2020
1 parent fc80497 commit 035d4c1
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
"""
Configuration file for rendering the documentation.
The files in this folder are used to render the documentation of this
package, from its source files, as a static web site. The renderer is
the documentation generator Sphinx. It is configured by this very
script and would be invoked on the command line via, on any operating
system, via `sphinx-build . rendered`. The static HTML then ends up in
the sub-folder `rendered`, where `index.html` is the start page.
This folder contains the documentation source files that are to be
rendered as a static web site by the documentation generator Sphinx.
The rendering process is configured by this very script and would be
triggered by running `sphinx-build . rendered` on the command line,
no matter the operating system. The rendered HTML then ends up in the
sub-folder `rendered`, where `index.html` is the start page.
The source files are the `.md` files here, where `index.md` maps to
the start page, as well as the documentation string in the package's
source code for the API documentation.
The documentation source is comprised of the `.md` files here, of which
`index.md` maps to the start page, as well as the documentation strings
in the package's source code for the API documentation.
All text may use mark-up according to the CommonMark specification of
the Markdown syntax. The Sphinx extension `recommonmark` is used to
the Markdown syntax. The Sphinx extension `reCommonMark` is used to
convert Markdown to reStructuredText, Sphinx's native input format.
"""
__license__ = 'MIT'
Expand Down

0 comments on commit 035d4c1

Please sign in to comment.