Switch to openstackdocstheme

Use openstackdocstheme instead of obsolete oslosphinx.

Fix display problem with removing extraneous whitespace in README.rst.

Change-Id: I791e830c6a13476152fb26a95de6832a6c50adae
This commit is contained in:
Andreas Jaeger 2017-08-26 14:54:50 +02:00
parent 9d40240edc
commit 29e92f930c
3 changed files with 16 additions and 18 deletions

View File

@ -371,10 +371,10 @@ on these platforms (and ideally Debian, Gentoo, and SUSE as well).
For people unfamiliar with Linux Distro packaging you can use the
following tools to search for packages:
- Ubuntu - http://packages.ubuntu.com/
- Fedora - https://apps.fedoraproject.org/packages/
- Gentoo - https://packages.gentoo.org/
- SUSE - https://build.opensuse.org/project/show/devel:languages:python
- Ubuntu - http://packages.ubuntu.com/
- Fedora - https://apps.fedoraproject.org/packages/
- Gentoo - https://packages.gentoo.org/
- SUSE - https://build.opensuse.org/project/show/devel:languages:python
For ``upper-constraints.txt`` changes
-------------------------------------

View File

@ -1,8 +1,5 @@
# -*- coding: utf-8 -*-
#
# Tempest documentation build configuration file, created by
# sphinx-quickstart on Tue May 21 17:43:32 2013.
#
# This file is execfile()d with the current directory set to its containing dir.
#
# Note that not all possible configuration values are present in this
@ -26,13 +23,10 @@ import os
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['oslosphinx']
extensions = ['openstackdocstheme']
todo_include_todos = True
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
@ -44,7 +38,7 @@ master_doc = 'index'
# General information about the project.
project = u'requirements'
copyright = u'2015, OpenStack Foundation'
copyright = u'2017, OpenStack Foundation'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@ -80,6 +74,11 @@ pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
modindex_common_prefix = ['requirements-doc.']
# openstackdocstheme options
repository_name = 'openstack/requirements'
bug_project = 'requirements'
bug_tag = ''
# -- Options for man page output ----------------------------------------------
man_pages = []
@ -87,7 +86,7 @@ man_pages = []
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
# html_theme = 'nature'
html_theme = 'openstackdocs'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
@ -115,8 +114,7 @@ man_pages = []
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
git_cmd = "git log --pretty=format:'%ad, commit %h' --date=local -n1"
html_last_updated_fmt = os.popen(git_cmd).read()
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
@ -224,7 +222,7 @@ texinfo_documents = [
epub_title = u'requirements Documentation'
epub_author = u'OpenStack'
epub_publisher = u'OpenStack'
epub_copyright = u'2015, OpenStack'
epub_copyright = u'2017, OpenStack'
# The language of the text. It defaults to the language option
# or en if the language is not set.

View File

@ -13,4 +13,4 @@ mock>=2.0.0 # BSD
# this is required for the docs build jobs
sphinx>=1.6.2 # BSD
oslosphinx>=4.7.0 # Apache-2.0
openstackdocstheme>=1.16.0 # Apache-2.0