Skip to main content

OPNFV Theme for Sphinx

Project description

This theme is used for all OPNFV documentation and is released seperatly from the documentation itself. It’s and extention of the Sphinx Bootstrap Theme

Installation

Here’s how to install the theme from PyPI

To install and configure the theme do the following.

  1. Install the theme from pypi:

    $ pip install sphinx_opnfv_theme
    
  2. Configure Sphinx to use the theme:

    # conf.py
    import sphinx_opnfv_theme
    
    # ...
    
    html_theme = 'opnfv'
    html_theme_path = sphinx_opnfv_theme.get_html_theme_path()
    

Customization

There are no customization specific to this theme yet, but all all customizations Sphinx Bootstrap Theme are supported.

If you’d like your documentation to match OPNFV’s style configure the following options for the bootstrap theme:

html_theme_options = {
  'bootswatch_theme': 'journal',
  'navbar_sidebarrel': False,
  'navbar_title': '',
}

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 sphinx-opnfv-theme, version 0.2.0
Filename, size File type Python version Upload date Hashes
Filename, size sphinx_opnfv_theme-0.2.0.tar.gz (10.9 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page