Skip to content

Commit 20cdc4e

Browse files
committed
Update contributing guide
1 parent 603ac01 commit 20cdc4e

File tree

2 files changed

+9
-3
lines changed

2 files changed

+9
-3
lines changed

.github/CONTRIBUTING.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,14 +98,20 @@ $ tox run -e docs-watch
9898

9999
This will build the documentation, watch for changes, and rebuild it whenever you save a file.
100100

101-
To just build the documentation and run doctests, use:
101+
To just build the documentation and exit immediately use:
102102

103103
```console
104-
$ tox run -e docs
104+
$ tox run -e docs-build
105105
```
106106

107107
You will find the built documentation in `docs/_build/html`.
108108

109+
To run doctests:
110+
111+
```console
112+
$ tox run -e docs-doctests
113+
```
114+
109115

110116
## Code
111117

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ jobs:
172172
if: ${{ failure() }}
173173

174174
docs:
175-
name: Run doctests
175+
name: Run doctests & render changelog
176176
runs-on: ubuntu-latest
177177
needs: build-package
178178
steps:

0 commit comments

Comments
 (0)