Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
josh-marshall-amp committed Jul 24, 2024
1 parent 783b51f commit 7b53a68
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions docs/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,9 @@ Currently we have the following:

# Building

- Uses [Sphinx](https://www.sphinx-doc.org/)
- `tox -e docs` will build, see `tox.ini::[testenv:docs]` section
- underneath it, with an appropriate venv: `fixate/docs > sphinx-build . _build`
- `docs/conf.py` has the configuration for build
The documentation build uses the Python-standard [Sphinx](https://www.sphinx-doc.org/), with configuration contained in `docs/conf.py`.

`tox -e docs` will run the docs build. See the `[testenv:docs]` section in `tox.ini` for configuration. Under the hood, it's essentially running `fixate/docs > sphinx-build <doc_src> <doc_dest>` in a venv with the requirements from docs/requirements.

# Docs from code

Expand Down

0 comments on commit 7b53a68

Please sign in to comment.