Skip to content

Add Doc shell script on unix #16676

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ it is expected to replace various mediums like:

```bash
pip install sphinx sphinx-design sphinxawesome-theme
make html
chmod a+x make.sh
./make.sh html
```

That's it! You can view the documentation under `./build/html/index.html` in your browser.
Expand Down
29 changes: 29 additions & 0 deletions docs/make.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
#!/bin/sh

# Command file for Sphinx documentation

if [ -z "$SPHINXBUILD" ]; then
SPHINXBUILD=sphinx-build
fi
SOURCEDIR=source
BUILDDIR=build

$SPHINXBUILD > /dev/null 2>&1
if [ $? -eq 127 ]; then
echo
echo "The 'sphinx-build' command was not found. Make sure you have Sphinx"
echo "installed, then set the SPHINXBUILD environment variable to point"
echo "to the full path of the 'sphinx-build' executable. Alternatively you"
echo "may add the Sphinx directory to PATH."
echo
echo "If you don't have Sphinx installed, grab it from"
echo "https://www.sphinx-doc.org/"
exit 1
fi

if [ -z "$1" ]; then
$SPHINXBUILD -M help $SOURCEDIR $BUILDDIR $SPHINXOPTS $O
exit 0
fi

$SPHINXBUILD -M "$1" $SOURCEDIR $BUILDDIR $SPHINXOPTS $O