openstack/openstackdocstheme
Code Issues Proposed changes
Sphinx theme for RST-sourced documentation published to docs.openstack.org
230 Commits 1 Branch 88 Tags 9 MiB
HTML 32.1%
Python 31.5%
CSS 16.4%
Shell 7.1%
Makefile 5.3%
Other 7.6%
3b8e21c961
Go to file
Flavio Percoco 3b8e21c961 Show team and repo badges on README 
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
2016-11-25 14:46:24 +01:00
api-ref/source Update test API Ref 2016-10-06 12:05:28 -04:00
doc/source Fix typo: remove redundant 'the' 2016-10-03 11:47:58 +07:00
openstackdocstheme [www] update page header links 2016-11-10 19:19:10 +09:00
releasenotes Enable release notes translation 2016-10-06 20:40:29 +02:00
.gitignore API References dropdown menu 2016-08-22 10:27:45 -05:00
.gitreview add a .gitreview file 2015-02-03 12:28:09 -05:00
bindep.txt Install required packages 2016-09-01 20:56:42 +02:00
CONTRIBUTING.rst Starting point for Sphinx theme for docs.openstack.org content 2015-01-20 10:49:21 -06:00
HACKING.rst Starting point for Sphinx theme for docs.openstack.org content 2015-01-20 10:49:21 -06:00
index.rst Adds working links to navigation dropdown and column 2015-01-28 10:16:40 -06:00
LICENSE Starting point for Sphinx theme for docs.openstack.org content 2015-01-20 10:49:21 -06:00
Makefile Starting point for Sphinx theme for docs.openstack.org content 2015-01-20 10:49:21 -06:00
README.rst Show team and repo badges on README 2016-11-25 14:46:24 +01:00
requirements.txt Updated from global requirements 2016-11-09 04:22:11 +00:00
setup.cfg Drop python classifiers from setup.cfg file 2016-01-14 01:58:56 +00:00
setup.py Updated from global requirements 2015-12-23 00:36:03 +00:00
test-requirements.txt Updated from global requirements 2016-11-02 15:38:36 +00:00
tox.ini Merge "Fix tox setup" 2016-09-02 17:15:54 +00:00

README.rst

Team and repository tags

image

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.

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'