- Create a Python 3 environment
- Install dependencies
pip install -r requirements.txt
- Build using
make html
(Mac/Linux) ormake.bat html
(Windows)
If you pip install sphinx-autobuild
, you can use make livehtml
which
will start a server that watches for source changes and will rebuild/refresh
automatically. Go to http://localhost:8000/ to see its output.
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