Skip to content

Commit a15b521

Browse files
authored
Clarify documentation build instructions
Updated instructions for installing dependencies and building documentation.
1 parent 956f82c commit a15b521

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

docs/source/contributing.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -108,15 +108,16 @@ please don't hesitate to make a contribution.
108108
The documentation is found in the `docs/source` folder, where the structure mirrors the rendered website.
109109

110110
Dependencies for building the documentation locally can be found at `docs/requirements.txt`.
111-
To install these, change directory to the `docs` folder in your terminal and type:
111+
To install these, from the root folder run:
112112

113113
```
114-
pip install -r requirements.txt
114+
pip install -r docs/requirements.txt
115115
```
116116

117-
The command to build the documentation is:
117+
From the docs folder, build the documentation with `make`:
118118

119119
```
120+
cd docs
120121
make clean api_index.rst html
121122
```
122123

0 commit comments

Comments
 (0)