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 and developer.openstack.org.
Intended for use by OpenStack `projects governed by the Technical Committee`_.
.. _`projects governed by the Technical Committee`:
http://governance.openstack.org/reference/projects/index.html
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", "rev-parse", "HEAD"]
gitsha = subprocess.Popen(
git_cmd, stdout=subprocess.PIPE).communicate()[0].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
* Release notes: http://docs.openstack.org/releasenotes/openstackdocstheme/
* Source: http://git.openstack.org/cgit/openstack/openstackdocstheme
* Bugs: http://bugs.launchpad.net/openstack-manuals
=========================================
Theme and extension support for Sphinx documentation that is published to
docs.openstack.org and developer.openstack.org.
Intended for use by OpenStack `projects governed by the Technical Committee`_.
.. _`projects governed by the Technical Committee`:
http://governance.openstack.org/reference/projects/index.html
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", "rev-parse", "HEAD"]
gitsha = subprocess.Popen(
git_cmd, stdout=subprocess.PIPE).communicate()[0].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
* Release notes: http://docs.openstack.org/releasenotes/openstackdocstheme/
* Source: http://git.openstack.org/cgit/openstack/openstackdocstheme
* Bugs: http://bugs.launchpad.net/openstack-manuals
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
openstackdocstheme-1.4.0.tar.gz
(359.9 kB
view details)
Built Distribution
File details
Details for the file openstackdocstheme-1.4.0.tar.gz.
File metadata
- Download URL: openstackdocstheme-1.4.0.tar.gz
- Upload date:
- Size: 359.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7b61f8328b1a0cc8ff79c10db0871a07da4ce1e01826d459016ee52acd88308c |
|
| MD5 | afab8bcad366eed0a0b7a8dea54bd1ad |
|
| BLAKE2b-256 | 1ede67459e23884d4689fcc10d7c0bb442e924b4db0eca8ac4b3ad870f81ae3e |
Provenance
File details
Details for the file openstackdocstheme-1.4.0-py2.py3-none-any.whl.
File metadata
- Download URL: openstackdocstheme-1.4.0-py2.py3-none-any.whl
- Upload date:
- Size: 202.2 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ee754f8d2dfacf5ab0c5d477bad85da5a3bf45e7aac721641ebcbd3c4f454ee7 |
|
| MD5 | 922fe52e71bebab5ed31a75e6882f68d |
|
| BLAKE2b-256 | e687a7b6b06f8153b5cdb7090035da31a6067222d82920cbd19786332877e3c1 |
