Skip to main content

OpenStack Docs Theme

Project description

OpenStack docs.openstack.org Sphinx Theme

Theme and extension support for Sphinx documentation that is published to docs.openstack.org. Intended for use by OpenStack projects.

Using the Theme

Prior to using this theme, ensure your project can use the OpenStack brand by referring to the brand guidelines at http://www.openstack.org/brand.

Update the requirements list for your project to include openstackdocstheme (usually in test-requirements.txt).

If your project previously used the oslosphinx theme (without modifying the header navigation), remove oslosphinx from your requirements list, and then in your conf.py you can remove the import statement and extension listing for oslosphinx.

Then modify your Sphinx settings in conf.py to include:

import openstackdocstheme

html_theme = 'openstackdocs'
html_theme_path = [openstackdocstheme.get_html_theme_path()]

Those settings are included in the file generated by Sphinx when you initialize a project, so they may already have values that need to be changed.

Project details


Release history Release notifications | RSS feed

This version

1.0.6

Download files

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

Source Distribution

openstackdocstheme-1.0.6.tar.gz (2.4 MB view details)

Uploaded Source

Built Distribution

openstackdocstheme-1.0.6-py2.py3-none-any.whl (2.3 MB view details)

Uploaded Python 2 Python 3

File details

Details for the file openstackdocstheme-1.0.6.tar.gz.

File metadata

File hashes

Hashes for openstackdocstheme-1.0.6.tar.gz
Algorithm Hash digest
SHA256 4279963bf23204e35bf88ea4809a3f6a2c5a7a839a1e2b2956a0e36997c880f0
MD5 f0cea713f76c3c66a676a2817e385803
BLAKE2b-256 769235311f0e1b8000113dcc3cdce05d3df6a9cd2222325534a3338572f06188

See more details on using hashes here.

Provenance

File details

Details for the file openstackdocstheme-1.0.6-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for openstackdocstheme-1.0.6-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 7c94ac9514f1b832c2d185a845e27c8397b8fab212535ab4ecb68c2c0bd2a904
MD5 448f3674ff8b1551916b3602af000e5a
BLAKE2b-256 218c53700e31b0afb2acf0a49fd4b75917b424c58c2425d494179ad3d0a4b787

See more details on using hashes here.

Provenance

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