- Create a Python 3 environment (virtual or with conda)
- Install dependencies
pip install -r requirements.txt - Build using
make html(Mac/Linux) ormake.bat html(Windows) - Use
make livehtmlto start a server that watches for source changes and will rebuild/refresh the docs 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
- Projects using Sphinx