Skip to main content

Sphinx themes used for documentation of my projects.

Project description

Custom Sphinx themes for the documentation of my projects.

Themes

  • yeen: Slight modification of the TriAx Corp theme.
  • Defaults to blue colours and sidebar on the left.
  • Field lists now use the mainlightcolor option for the background colour for headers, rather than a hardcoded blue colour.
  • Optionally adds a Github “Octocat” banner to the repository (created by Tim Holman).

Usage

To use the theme, specify allanc_sphinx[yeen] as a dependency, and in your conf.py file:

html_theme = 'yeen'

If you want to add the Octocat banner, you just need to define the link you want to go to - for example:

html_theme_options = {'github_url': 'https://github.com/the-allanc/allanc_sphinx'}

Project details


Download files

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

Files for allanc-sphinx, version 0.3
Filename, size File type Python version Upload date Hashes
Filename, size allanc_sphinx-0.3-py3-none-any.whl (3.9 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size allanc_sphinx-0.3.tar.gz (3.0 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page