Skip to content

Commit

Permalink
readme: use newer sphinx for local docs building
Browse files Browse the repository at this point in the history
  • Loading branch information
krzemin committed Aug 2, 2023
1 parent 79730d5 commit db0192b
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,9 +170,11 @@ Chimney documentation is available at https://chimney.readthedocs.io.
For building documentation locally you can use Docker:

```bash
docker run --rm -v "$PWD/docs:/docs" sphinxdoc/sphinx:3.2.1 bash -c "pip install sphinx-rtd-theme && make html"
docker run --rm -v "$PWD/docs:/docs" sphinxdoc/sphinx:5.3.0 bash -c "pip install sphinx-rtd-theme && make html"
```

It will build the docs in the `./docs/build/html/` directory.

## Thanks

Thanks to [JProfiler (Java profiler)](https://www.ej-technologies.com/products/jprofiler/overview.html)
Expand Down

0 comments on commit db0192b

Please sign in to comment.