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.

Source Distribution

allanc_sphinx-0.4.tar.gz (5.1 kB view hashes)

Uploaded source

Built Distribution

allanc_sphinx-0.4-py3-none-any.whl (6.0 kB view hashes)

Uploaded py3

Supported by

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