openstack
/
openstackdocstheme
Code Issues Proposed changes
Sphinx theme for RST-sourced documentation published to docs.openstack.org
283 Commits 1 Branch 86 Tags 8.4 MiB
HTML 32.3%
Python 31.2%
CSS 16.5%
Shell 7.1%
Makefile 5.3%
Other 7.6%
Go to file
Anne Gentle 6c906c06d1 Working on integrating options from oslosphinx theme 
- First patch only modifies tox.ini to add an html-only
  build option to iterate quickly.
- Modify .gitignore for working on Mac OSX locally.

Next patches in series will take care of:
- Adds a Project-only search form in bottom of left-hand navigation bar
  Trying to differentiate between project-scoped search and broad
  site search.
- The "Project Home page" link renamed from "Contents" in nav.
- Build number now available in lines "Updated" also is
  displayed. Shows a bulleted list with "Current" if that is the
  only available version. Seems to have a lot of space, okay?
- Add a link to project source in sidebar.

Change-Id: Ic71c1f7c17048c521fce4b08989b0c57c175e043
 		2017-06-26 13:47:17 -05:00
api-ref/source Use https instead of http for git.openstack.org 2017-02-09 00:17:37 +00:00
doc/source automate some of the extension setup 2017-06-24 07:20:01 +00:00
openstackdocstheme automate some of the extension setup 2017-06-24 07:20:01 +00:00
releasenotes switch release notes build to use openstackdocs instead of oslosphinx 2017-06-26 13:45:07 +00:00
tools Add Constraints support 2016-12-21 12:01:20 +11:00
.gitignore Working on integrating options from oslosphinx theme 2017-06-26 13:47:17 -05:00
.gitreview add a .gitreview file 2015-02-03 12:28:09 -05:00
CONTRIBUTING.rst Update Launchpad info 2017-02-17 10:26:28 +10:00
HACKING.rst Update Launchpad info 2017-02-17 10:26:28 +10: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 automate some of the extension setup 2017-06-24 07:20:01 +00:00
bindep.txt PDF build support >= Sphinx 1.6.1 2017-06-01 23:31:07 +00:00
index.rst Update Launchpad info 2017-02-17 10:26:28 +10:00
requirements.txt Updated from global requirements 2017-04-12 04:19:26 +00:00
setup.cfg Add warning-is-error 2017-03-03 07:26:24 +00:00
setup.py Updated from global requirements 2017-03-02 11:52:44 +00:00
test-requirements.txt switch release notes build to use openstackdocs instead of oslosphinx 2017-06-26 13:45:07 +00:00
tox.ini Working on integrating options from oslosphinx theme 2017-06-26 13:47:17 -05: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 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'