s2t2 / learning-sphinx

Learning Sphinx / Restructured Text

Setup environment and install Sphinx:

conda create -n docs-env python=3.10

conda activate docs-env

pip install -r requirements.txt

Getting Started:

cd docs/

# first time only:
sphinx-quickstart

Build HTML (from the docs directory):

make html

open -a"Google Chrome" build/html/index.html

Build latex:

make latex

References:

• How to Document using Sphinx: Part 1 — Setting up
• Part 2