This repository is the home of the SpongeDocs homepage and theme. The SpongeDocs theme is a customized version of the Read the Docs Sphinx Theme with custom modifications to adapt it to our brand.
We also extend it with a few additional features:
- Language and version selection
- "Offline Mode": Service Worker that downloads the entire documentation to make it available offline.
- Light/dark theme selection
In terminal or the command line, within the directory containing this README, run the following commands:
npm install -g gulp npm install pip install -r requirements.txt
src folder contains all sources. All other folders (e.g.
sponge_docs_theme) contain generated files and should
not be edited. The sources for the theme are in
src/theme, the homepage sources are in
The theme can be built using
gulp theme:build. To rebuild the theme when changes to the local source files are made,
To test the changes, setup a SpongeDocs workspace and install your local
sponge-docs-theme project as PIP package:
pip install -e path/to/your/sponge-docs-theme.
The homepage can be built using
gulp homepage:build. Run
gulp homepage to listen for local changes and to start a
webserver at http://localhost:8000.