openstack/tempest
Code Issues Proposed changes

Merge "Update document theme and section headers"

Browse Source
This commit is contained in:
Jenkins 2017-05-16 08:50:57 +00:00 committed by Gerrit Code Review
commit a8006de318
5 changed files with 12 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/source/conf.py
View File

@ -27,6 +27,8 @@ import os
import subprocess import subprocess
import warnings import warnings
import openstackdocstheme
# Build the plugin registry # Build the plugin registry
def build_plugin_registry(app): def build_plugin_registry(app):
root_dir = os.path.dirname( root_dir = os.path.dirname(
@ -117,7 +119,7 @@ modindex_common_prefix = ['tempest.']
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # 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 # 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 # further. For a list of options available for each theme, see the
@ -125,7 +127,7 @@ html_theme = 'nature'
#html_theme_options = {} #html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory. # Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = [] html_theme_path = [openstackdocstheme.get_html_theme_path()]
# The name for this set of Sphinx documents. If None, it defaults to # The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation". # "<project> v<release> documentation".

14
doc/source/index.rst
View File

@ -2,18 +2,16 @@
Tempest Testing Project Tempest Testing Project
======================= =======================
--------
Overview Overview
-------- ========
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
overview overview
------------
Field Guides Field Guides
------------ ============
Tempest contains tests of many different types, the field guides Tempest contains tests of many different types, the field guides
attempt to explain these in a way that makes it easy to understand attempt to explain these in a way that makes it easy to understand
where your test contributions should go. where your test contributions should go.
@ -26,11 +24,9 @@ where your test contributions should go.
field_guide/scenario field_guide/scenario
field_guide/unit_tests field_guide/unit_tests
=========
For users For users
========= =========
---------------------------
Tempest Configuration Guide Tempest Configuration Guide
--------------------------- ---------------------------
@ -40,7 +36,6 @@ Tempest Configuration Guide
configuration configuration
sampleconf sampleconf
---------------------
Command Documentation Command Documentation
--------------------- ---------------------
@ -53,11 +48,9 @@ Command Documentation
workspace workspace
run run
==============
For developers For developers
============== ==============
-----------
Development Development
----------- -----------
@ -70,7 +63,6 @@ Development
test_removal test_removal
write_tests write_tests
-------
Plugins Plugins
------- -------
@ -80,7 +72,6 @@ Plugins
plugin plugin
plugin-registry plugin-registry
-------
Library Library
------- -------
@ -89,7 +80,6 @@ Library
library library
==================
Indices and tables Indices and tables
================== ==================

6
releasenotes/source/conf.py
View File

@ -111,7 +111,7 @@ pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # a list of builtin themes.
html_theme = 'default' html_theme = 'openstackdocs'
# Theme options are theme-specific and customize the look and feel of a theme # 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 # further. For a list of options available for each theme, see the
@ -119,7 +119,9 @@ html_theme = 'default'
# html_theme_options = {} # html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory. # Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = [] import openstackdocstheme
html_theme_path = [openstackdocstheme.get_html_theme_path()]
# The name for this set of Sphinx documents. If None, it defaults to # The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation". # "<project> v<release> documentation".

2
releasenotes/source/index.rst
View File

@ -1,5 +1,5 @@
=========================== ===========================
tempest Release Notes Tempest Release Notes
=========================== ===========================
.. toctree:: .. toctree::

1
test-requirements.txt
View File

@ -10,3 +10,4 @@ mock>=2.0 # BSD
coverage>=4.0 # Apache-2.0 coverage>=4.0 # Apache-2.0
oslotest>=1.10.0 # Apache-2.0 oslotest>=1.10.0 # Apache-2.0
flake8-import-order==0.11 # LGPLv3 flake8-import-order==0.11 # LGPLv3
openstackdocstheme>=1.5.0 # Apache-2.0