Requires Python 3 and tox.
# Start dev server (refreshes output on change)
tox
# Build just HTML output
tox -- htmlNOTE: add an empty .nojekyll file to the final html folder for github pages to load css files.
rST is a bit more onerous than Markdown, but it includes more advanced features like inter-page references/links and a suite of directives.
- Sphinx's primer
- Full Docutils reference
- also see its Quick rST cheat sheet.
- Online rST editor (it gets some things wrong)
- Other projects that use rST/Sphinx
- Python: click the "Show Source" under "This Page" in the sidebar.
- Sphinx: similar
- Numpy; note that the landing pages are usually coded in HTML and can be found in the templates directory, e.g. Numpy's landing page
RST supports arbitrary heading styles; the parser will treat the first style it encounters as an h1 heading, the second an h2 heading, and so on. Here are the recommended heading styles you can use:
==============
Title heading
==============
h1 heading
==========
h2 heading
----------
h3 heading
~~~~~~~~~~
h4 heading
^^^^^^^^^^
h5 heading
``````````