We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
2 parents fcf09e7 + 6a49538 commit 238a8f6Copy full SHA for 238a8f6
.gitignore
@@ -1,3 +1,7 @@
1
_env
2
site
3
-.DS_Store
+.DS_Store
4
+bin
5
+lib
6
+lib64
7
+pyvenv.cfg
README.md
@@ -22,9 +22,16 @@ To setup the documentation development environment simply create a new
22
virtual environment, then `pip install -r requirements.txt` (from in the root
23
of this repository).
24
25
+```sh
26
+# example of a simple virtual environment
27
+# creation from the root of this project
28
+python -m venv .
29
+./bin/pip install -r requirements.txt
30
+```
31
+
32
## Build
33
-Simply run `mkdocs serve`
34
+Simply run `mkdocs serve` or `./bin/mkdocs serve`.
35
36
## Cross-referencing
37
0 commit comments