3b8e21c961
This patch adds the team's and repository's badges to the README file. The motivation behind this is to communicate the project status and features at first glance. For more information about this effort, please read this email thread: http://lists.openstack.org/pipermail/openstack-dev/2016-October/105562.html To see an example of how this would look like check: b'https://gist.github.com/4f7ebfa0c85e8007a41d4bc5c8f4ec97\n' Change-Id: If173ce9a047c6df285283a735ce15a90d4f7cea3
69 lines
2.5 KiB
ReStructuredText
69 lines
2.5 KiB
ReStructuredText
========================
|
|
Team and repository tags
|
|
========================
|
|
|
|
.. image:: http://governance.openstack.org/badges/openstackdocstheme.svg
|
|
:target: http://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`:
|
|
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
|
|
|