Skip to main content

A Sphinx theme for the PICOS documentation.

Project description

PICOS Sphinx Theme (picos-sphinx-theme) is a Sphinx theme forked from the Faculty Sphinx Theme which in turn is based on the Read the Docs Sphinx Theme.

You can see the theme in action on the PICOS Documentation.

Installation

pip install picos-sphinx-theme

Usage

Load the "picos_sphinx_theme" extension and set html_theme to "picos". Additionally, you can set the following options via html_theme_options:

  • "gitlab_ribbon": Whether to add the Fork me on GitLab ribbon.

  • "gitlab_ribbon_url": GitLab repository URL.

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

picos-sphinx-theme-0.0.36.tar.gz (9.7 kB view hashes)

Uploaded Source

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