readonly-docs-theme

This is the source-code of the ReadOnlyDocs theme. The ReadOnlyDocs theme is a customized version of the Read the Docs Sphinx Theme with custom modifications.

Contributing

The ReadOnlyDocs theme is built using Node.js and gulp.

1. Install Python 3
2. Install Node.js

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

Project structure

The src folder contains all sources. All other folders (e.g. readonly_docs_theme) contain generated files and should not be edited. The sources for the theme are in src/theme.

Theme

The theme can be built using gulp theme:build. To rebuild the theme when changes to the local source files are made, run gulp theme:watch.

To test the changes, setup a ReadOnlyDocs workspace and install your local readonly-docs-theme project as PIP package: pip install -e path/to/your/readonly-docs-theme.