If you find bugs, errors, omissions or other things that need improvement, please create an issue or a pull request at https://github.com/mgeier/insipid-sphinx-theme/. Contributions are always welcome!
git clone https://github.com/mgeier/insipid-sphinx-theme.git --recursive cd insipid-sphinx-theme python3 -m pip install -e . --user
-e stands for
When installing this way, you can quickly try other Git branches (in this example the branch is called “another-branch”):
git checkout another-branch
If you want to go back to the “master” branch, use:
git checkout master
To get the latest changes from Github, use:
git pull --ff-only
If you used the
--recursive option when cloning,
Font-Awesome submodule (containing the SVG icons)
will be checked out automatically.
If not, you can get the submodule with:
git submodule update --init
Building the Documentation§
If you make changes to the documentation, you should create the HTML pages locally using Sphinx and check if they look OK.
Initially, you might need to install a few packages that are needed to build the documentation:
python3 -m pip install -r doc/requirements.txt --user
To (re-)build the HTML files, use:
python3 setup.py build_sphinx
The generated files will be available in the directory