Skip to main content

mrtoolstheme: a Sphinx theme

Project description

A Sphinx HTML Theme based on the arctic, north-bluish color palette.

Usage

On Sphinx project’s conf.py: set the theme name to mrtools.

html_theme = "mrtools"

See details on Sphinx theming docs.

License

GNU AFFERO GENERAL PUBLIC LICENSE Version 3

Developer guide

Upgrade your setup tools and pip. They are needed for development and testing only:

pip install --upgrade setuptools pip wheel

Development steps for code changes

git clone https://gitlab.com/anatas_ch/pyl_mrtoolstheme.git
cd pyl_mrtoolstheme
pip install -e .

Then install relevant development requirements:

pip install -r requirements_rnd.txt

docs folder contains theme’s own documentantion.

cd docs
make clean; make html

Once you have finished your changes, please provide test case(s) and relevant documentation.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mrtoolstheme-0.4.0.tar.gz (45.6 kB view hashes)

Uploaded Source

Built Distribution

mrtoolstheme-0.4.0-py3-none-any.whl (20.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page