Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: tox -e docs-deps to compile requirements.txt #1172

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions HACKING.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@ tox -e unit test/test_charm.py
# Format the code using isort and autopep8
tox -e fmt

# Compile the requirements.txt file for docs
tox -e docs-deps

# Generate a local copy of the Sphinx docs in docs/_build
tox -e docs

Expand Down Expand Up @@ -198,6 +201,13 @@ tox -e docs
open docs/_build/html/index.html
```

If dependencies are updated in `pyproject.toml`, you can run the following command
before generating docs to recompile the `requirements.txt` file used for docs:

```sh
tox -e docs-deps
```

## How to Pull in Style Changes

The documentation uses Canonical styling which is customised on top of the [Furo Sphinx theme](https://github.com/pradyunsg/furo). The easiest way to pull in Canonical style changes is by using the Canonical documentation starter pack, see [docs](https://canonical-starter-pack.readthedocs-hosted.com/) and [repository](https://github.com/canonical/sphinx-docs-starter-pack).
Expand Down
7 changes: 6 additions & 1 deletion tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,16 @@ passenv =
PATH
MODEL_SETTINGS

[testenv:docs-deps]
description = Compile the requirements.txt file for docs
deps = pip-tools
commands =
pip-compile --extra=docs -o docs/requirements.txt pyproject.toml

[testenv:docs]
description = Build the Sphinx docs
deps = pip-tools
commands_pre =
pip-compile --extra=docs -o docs/requirements.txt pyproject.toml
pip-sync {toxinidir}/docs/requirements.txt
commands =
sphinx-build -W --keep-going docs/ docs/_build/html
Expand Down
Loading