-
Notifications
You must be signed in to change notification settings - Fork 34
Commit
I've also tried to make the developer documentation easier to discover
- Loading branch information
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -61,14 +61,18 @@ $ tox -e coverage | |
|
||
## Documentation environment | ||
|
||
The `docs` environment builds the [Sphinx] documentation locally. If the build succeeds, it can be viewed by navigating to `docs/_build/html/index.html` in a web browser. | ||
The `docs` environment builds the [Sphinx] documentation locally. | ||
|
||
To run: | ||
For the documentation build to succeed, [pandoc](https://pandoc.org/) must be installed. Pandoc is not available via pip, so must be installed through some other means. Linux users are encouraged to install it through their package manager (e.g., `sudo apt-get install -y pandoc`), while macOS users are encouraged to install it via [Homebrew](https://brew.sh/) (`brew install pandoc`). Full instructions are available on [pandoc's installation page](https://pandoc.org/installing.html). | ||
|
||
To run this environment: | ||
|
||
```sh | ||
$ tox -e docs | ||
``` | ||
|
||
If the build succeeds, it can be viewed by navigating to `docs/_build/html/index.html` in a web browser. Specifically, run `pwd` in the same terminal in which you built the docs, then copy that location and paste it in your web browser. You should see a directory listing there. If not, prepend `file://` to the path and try again. Once you see the directory listing, click on `docs`, then `_build`, then `html`, and then finally `index.html` to view the documentation. | ||
This comment has been minimized.
Sorry, something went wrong.
This comment has been minimized.
Sorry, something went wrong.
garrison
Author
Member
|
||
|
||
[tox]: https://github.com/tox-dev/tox | ||
[`tox.ini`]: ../tox.ini | ||
[mypy]: https://mypy.readthedocs.io/en/stable/ | ||
|
Isn't it true that Ubuntu, RHEL, macOS, and Windows would all open the web browser automatically, if you simply opened the html file through the GUI? We could simplify this a lot if we just told users to open the file. Just a thought