OpenStack Docs Theme
Project description
========================
Team and repository tags
========================
.. image:: https://governance.openstack.org/badges/openstackdocstheme.svg
:target: https://governance.openstack.org/reference/tags/index.html
.. Change things from this point on
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`:
https://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
https://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::
html_theme = 'openstackdocs'
and to add ``'openstackdocstheme'`` to the list of extensions Sphinx
needs to initialize::
extensions = [
# ...
'openstackdocstheme',
# ...
]
Set the options to link to the git repository and bug tracker.
``repository_name``
The prefix and repo name. For example,
``'openstack/python-glanceclient'``.
``bug_project``
The launchpad project name. For example, ``python-glanceclient``.
``bug_tag``
Launchpad bug tag. If unspecified, no tag is set. The default is
empty.
For example::
# openstackdocstheme options
repository_name = 'openstack/python-glanceclient'
bug_project = 'python-glanceclient'
bug_tag = ''
Enable the "last-updated" information by setting the format for the
timestamp::
# 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: https://docs.openstack.org/releasenotes/openstackdocstheme/
* Source: https://git.openstack.org/cgit/openstack/openstackdocstheme
* Bugs: https://launchpad.net/openstack-doc-tools
Team and repository tags
========================
.. image:: https://governance.openstack.org/badges/openstackdocstheme.svg
:target: https://governance.openstack.org/reference/tags/index.html
.. Change things from this point on
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`:
https://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
https://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::
html_theme = 'openstackdocs'
and to add ``'openstackdocstheme'`` to the list of extensions Sphinx
needs to initialize::
extensions = [
# ...
'openstackdocstheme',
# ...
]
Set the options to link to the git repository and bug tracker.
``repository_name``
The prefix and repo name. For example,
``'openstack/python-glanceclient'``.
``bug_project``
The launchpad project name. For example, ``python-glanceclient``.
``bug_tag``
Launchpad bug tag. If unspecified, no tag is set. The default is
empty.
For example::
# openstackdocstheme options
repository_name = 'openstack/python-glanceclient'
bug_project = 'python-glanceclient'
bug_tag = ''
Enable the "last-updated" information by setting the format for the
timestamp::
# 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: https://docs.openstack.org/releasenotes/openstackdocstheme/
* Source: https://git.openstack.org/cgit/openstack/openstackdocstheme
* Bugs: https://launchpad.net/openstack-doc-tools
Project details
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
Close
Hashes for openstackdocstheme-1.11.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cb3c88bff68ebdda3eb22c2d480bf7cdde00256906f0d534ed16dcbbfa1900fd |
|
MD5 | 740c7195283f05641f67d7d310a38056 |
|
BLAKE2b-256 | 5e73f6056c4065ea4e29c83026ee2750836543c3671c89ff74779e809f2944ad |
Close
Hashes for openstackdocstheme-1.11.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ac0c7730f9d31f8f87223836d5012c028e8a1d7c0a03f563c35f96947b10a5df |
|
MD5 | de5c1298e2bc2966003adcd6dce16e12 |
|
BLAKE2b-256 | 72560007c932323a4db699af11b299ba725222212219bf42275637b27b09f669 |