From 866feaf08bbd92f385282b1187fe165c678ed752 Mon Sep 17 00:00:00 2001 From: Thierry Carrez Date: Tue, 2 Oct 2018 11:50:56 +0200 Subject: [PATCH] Inherit openstackdocstheme The governance websites were using an old theme. This patch switches the theme to inherit from the more modern openstackdocstheme, for a consistent look across all governance subwebsites (and easier navigation between them). Similar patches have been posted for governance.o.o/, governance.o.o/sigs and governance.o.o/tc. Change-Id: Ie5526ce73c6f3ab6eced729aa12068f55ca2df0b --- doc/source/_themes/governance/sidebartoc_menu.html | 8 ++++++++ doc/source/_themes/governance/theme.conf | 2 ++ doc/source/conf.py | 13 ++++++++----- test-requirements.txt | 4 ++-- 4 files changed, 20 insertions(+), 7 deletions(-) create mode 100644 doc/source/_themes/governance/sidebartoc_menu.html create mode 100644 doc/source/_themes/governance/theme.conf diff --git a/doc/source/_themes/governance/sidebartoc_menu.html b/doc/source/_themes/governance/sidebartoc_menu.html new file mode 100644 index 0000000..e326a3a --- /dev/null +++ b/doc/source/_themes/governance/sidebartoc_menu.html @@ -0,0 +1,8 @@ + + diff --git a/doc/source/_themes/governance/theme.conf b/doc/source/_themes/governance/theme.conf new file mode 100644 index 0000000..8a7962d --- /dev/null +++ b/doc/source/_themes/governance/theme.conf @@ -0,0 +1,2 @@ +[theme] +inherit = openstackdocs diff --git a/doc/source/conf.py b/doc/source/conf.py index 84acf4b..19b8e62 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -31,7 +31,7 @@ sys.path.insert(0, os.path.join(os.path.abspath('.'), '_exts')) # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = [ 'sphinx.ext.extlinks', - 'oslosphinx', + 'openstackdocstheme', 'members', 'teamtable', ] @@ -100,19 +100,22 @@ modindex_common_prefix = [] # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'nature' +html_theme = 'governance' # 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 # documentation. -#html_theme_options = {} +html_theme_options = { + 'display_global_toc_section': False, + 'root_title': 'OpenStack Governance' +} # Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] +html_theme_path = ['_themes'] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". -#html_title = None +html_title = 'OpenStack Governance' # A shorter title for the navigation bar. Default is the same as html_title. #html_short_title = None diff --git a/test-requirements.txt b/test-requirements.txt index 40bcba4..278c52a 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -3,5 +3,5 @@ # process, which may cause wedges in the gate later. # needed for doc build docutils>=0.11,!=0.13.1 # OSI-Approved Open Source, Public Domain -sphinx!=1.2.0,!=1.3b1,<1.3,>=1.1.2 # BSD -oslosphinx!=3.4.0,>=2.5.0 # Apache-2.0 +sphinx>=1.5.0 # BSD +openstackdocstheme>=1.25.1 # Apache-2.0