File tree Expand file tree Collapse file tree 2 files changed +31
-1
lines changed Expand file tree Collapse file tree 2 files changed +31
-1
lines changed Original file line number Diff line number Diff line change @@ -15,7 +15,8 @@ it is expected to replace various mediums like:
15
15
16
16
``` bash
17
17
pip install sphinx sphinx-design sphinxawesome-theme
18
- make html
18
+ chmod a+x make.sh
19
+ ./make.sh html
19
20
```
20
21
21
22
That's it! You can view the documentation under ` ./build/html/index.html ` in your browser.
Original file line number Diff line number Diff line change
1
+ #! /bin/sh
2
+
3
+ # Command file for Sphinx documentation
4
+
5
+ if [ -z " $SPHINXBUILD " ]; then
6
+ SPHINXBUILD=sphinx-build
7
+ fi
8
+ SOURCEDIR=source
9
+ BUILDDIR=build
10
+
11
+ $SPHINXBUILD > /dev/null 2>&1
12
+ if [ $? -eq 127 ]; then
13
+ echo
14
+ echo " The 'sphinx-build' command was not found. Make sure you have Sphinx"
15
+ echo " installed, then set the SPHINXBUILD environment variable to point"
16
+ echo " to the full path of the 'sphinx-build' executable. Alternatively you"
17
+ echo " may add the Sphinx directory to PATH."
18
+ echo
19
+ echo " If you don't have Sphinx installed, grab it from"
20
+ echo " https://www.sphinx-doc.org/"
21
+ exit 1
22
+ fi
23
+
24
+ if [ -z " $1 " ]; then
25
+ $SPHINXBUILD -M help $SOURCEDIR $BUILDDIR $SPHINXOPTS $O
26
+ exit 0
27
+ fi
28
+
29
+ $SPHINXBUILD -M " $1 " $SOURCEDIR $BUILDDIR $SPHINXOPTS $O
You can’t perform that action at this time.
0 commit comments