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.
Some of the settings below are included in the file generated by Sphinx when you initialize a project, so they may already have values that need to be changed.
Then modify your Sphinx settings in conf.py to include:
import openstackdocstheme html_theme = 'openstackdocs' html_theme_path = [openstackdocstheme.get_html_theme_path()]
Also, you must include these variables so that the “Log a bug” link sends metadata for the project where the docs reside:
# We ask git for the SHA checksum
# The git SHA checksum is used by "log-a-bug"
git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '"
gitsha = os.popen(git_cmd).read().strip('\n')
# tag that reported bugs will be tagged with
bug_tag = "your-chosen-tag"
# source tree
pwd = os.getcwd()
# html_context allows us to pass arbitrary values into the html template
html_context = {"pwd": pwd, "gitsha": gitsha}
# Must set this variable to include year, month, day, hours, and minutes.
html_last_updated_fmt = '%Y-%m-%d %H:%M'
Free software: Apache License, Version 2.0
Documentation: http://docs.openstack.org/developer/openstackdocstheme
Source: http://git.openstack.org/cgit/openstack/openstackdocstheme
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file openstackdocstheme-1.2.0.tar.gz.
File metadata
- Download URL: openstackdocstheme-1.2.0.tar.gz
- Upload date:
- Size: 2.6 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 0eab5b6fd5d666ac39704697915db037d94818681280ea77fb4c93b07dbccdb4 |
|
| MD5 | 2c508687dfa2bf35cd6728fa91ba0b32 |
|
| BLAKE2b-256 | 80c650362a80058df5c2b763aba85ca878952350a5f91087313e57306b0b5139 |
Provenance
File details
Details for the file openstackdocstheme-1.2.0-py2.py3-none-any.whl.
File metadata
- Download URL: openstackdocstheme-1.2.0-py2.py3-none-any.whl
- Upload date:
- Size: 2.3 MB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4ba595c29ed9743ef8dc2baad864cfa955681b91f5bab155f9ef5f5ef9a2cc72 |
|
| MD5 | 936c371aa69fea5ba554bef4d85fe30b |
|
| BLAKE2b-256 | 6b3a6a824927d546256d39b1ed22d0924be9a6607d98098b8ae3100aadb5044d |
