Skip to content

Commit

Permalink
Change to dirhtml builder (#667)
Browse files Browse the repository at this point in the history
  • Loading branch information
choldgraf authored Apr 12, 2023
1 parent 659169b commit 328186f
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 3 deletions.
1 change: 1 addition & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ build:

sphinx:
configuration: conf.py
builder: dirhtml

python:
install:
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ To do so, follow these steps:
$ nox -s docs
```

This should create a local environment in a `.nox` folder, build the documentation (as specified in the `noxfile.py` configuration), and the output will be in `_build/html`.
This should create a local environment in a `.nox` folder, build the documentation (as specified in the `noxfile.py` configuration), and the output will be in `_build/dirhtml`.

To build live documentation that updates when you update local files, run the following command:

Expand Down
2 changes: 1 addition & 1 deletion noxfile.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

nox.options.reuse_existing_virtualenvs = True

build_command = ["-b", "html", ".", "_build/html"]
build_command = ["-b", "dirhtml", ".", "_build/dirhtml"]


@nox.session
Expand Down
2 changes: 1 addition & 1 deletion reference/documentation/environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ This differs slightly depending on the repository, but it usually works like thi
3. **Build the documentation with Sphinx**. Finally, you can build the documentation locally with Sphinx using a command like so:

```shell
sphinx-build docs docs/_build/html
sphinx-build -b dirhtml docs docs/_build/dirhtml
```

See [the Sphinx documentation](https://www.sphinx-doc.org/en/master/) for more details.

0 comments on commit 328186f

Please sign in to comment.