Getting Started =============== 1. Create a venv and install docs deps ------------------------------------- .. code-block:: bash python -m venv .venv # Windows PowerShell: # .\.venv\Scripts\Activate.ps1 # Linux/macOS: # source .venv/bin/activate pip install -r docs/requirements.txt 2. Build HTML ------------ From repository root: .. code-block:: bash sphinx-build -b html docs docs/_build/html Then open: * ``docs/_build/html/index.html`` 3. Write docs in reStructuredText --------------------------------- For math-heavy content, you mainly use: * inline math: ``:math:`...` `` * block math: ``.. math::`` with optional ``:label:`` for equation references * equation reference: ``:eq:`your-label` ``