Skip to content

ain-soph/trojanzoo_sphinx_theme

Repository files navigation

TrojanZoo Sphinx Theme

sphinx>=7.0

demo release pypi

Sphinx theme for TrojanZoo Docs based on the Read the Docs Sphinx Theme. Forked from Pytorch Sphinx Theme with commit b4d0005 at 09/24/2021.

Difference from pytorch_sphinx_theme

This work removes all pytorch-related things and support many customizations. It also removes all other unnecessary items to make it a pure doc template.
See demos at:
https://ain-soph.github.io/trojanzoo_sphinx_theme/
https://ain-soph.github.io/alpsplot/
https://ain-soph.github.io/trojanzoo/

Local Development

Run python setup:

git clone https://github.com/ain-soph/trojanzoo_sphinx_theme
pip install -e trojanzoo_sphinx_theme

and install the dependencies using pip install -r requirements.txt

In the root directory install the package.json:

# node version 8.4.0
yarn install

If you have npm installed then run:

npm install

Run grunt to build the html site and enable live reloading of the demo app at localhost:1919:

grunt