README.rst

Cobra Sphinx Theme

Contents

• Installation
• Configuration
  • Project-wide configuration
  • Page-level configuration

Installation

Download the package or add it to your requirements.txt file:

$ pip install sphinx_cobra_theme

In your conf.py file:

import sphinx_cobra_theme

html_theme = "sphinx_cobra_theme"

html_theme_path = [sphinx_cobra_theme.get_html_theme_path()]

Configuration

You can configure different parts of the theme.

Project-wide configuration

The theme's project-wide options are defined in the sphinx_cobra_theme/theme.conf file of this repository, and can be defined in your project's conf.py via html_theme_options. For example:

html_theme_options = {
    'collapse_navigation': False,
    'display_version': False,
    'navigation_depth': 3,
}

Page-level configuration

Pages support metadata that changes how the theme renders. You can currently add the following:

• :github_url: This will force the "Edit on GitHub" to the configured URL
• :bitbucket_url: This will force the "Edit on Bitbucket" to the configured URL
• :gitlab_url: This will force the "Edit on GitLab" to the configured URL