diff --git a/doc/requirements.txt b/doc/requirements.txt index 9e9e821a..743d92a3 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,2 +1,3 @@ -sphinx>=1.2.1,!=1.3b1,<1.4 # BSD -oslosphinx>=4.7.0 # Apache-2.0 +openstackdocstheme>=1.20.0 # Apache-2.0 +reno>=1.8.0 # Apache-2.0 +sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD diff --git a/doc/source/conf.py b/doc/source/conf.py index 9b7a8af8..2d0f9879 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -12,20 +12,24 @@ # See the License for the specific language governing permissions and # limitations under the License. -import os -import sys -sys.path.insert(0, os.path.abspath('../..')) # -- General configuration ---------------------------------------------------- # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = [ - 'sphinx.ext.autodoc', + 'openstackdocstheme', #'sphinx.ext.intersphinx', - 'oslosphinx' + 'sphinx.ext.autodoc' ] +html_theme = 'openstackdocs' + +# openstackdocstheme options +repository_name = 'openstack/python-tempestconf' +bug_project = '912' +bug_tag = 'doc' + # autodoc generation is a bit aggressive and a nuisance when doing heavy # text edit cycles. # execute "export SPHINX_DEBUG=1" in your terminal to disable @@ -37,7 +41,7 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'python-tempestconf' +project = 'python-tempestconf' copyright = u'2016, Red Hat' # If true, '()' will be appended to :func: etc. cross-reference text. diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index e913e96f..6f10ef27 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -38,10 +38,15 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'oslosphinx', + 'openstackdocstheme', 'reno.sphinxext', ] +# openstackdocstheme options +repository_name = 'openstack/python-tempestconf' +bug_project = '912' +bug_tag = 'releasenotes' + # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -55,19 +60,8 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'tempest_config Release Notes' copyright = u'2016, OpenStack Foundation' -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. -# The full version, including alpha/beta/rc tags. -release = '' -# The short X.Y version. -version = '' - # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # language = None @@ -111,7 +105,7 @@ pygments_style = 'sphinx' # The theme to use for HTML and HTML Help pages. See the documentation for # 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 # further. For a list of options available for each theme, see the diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst index d826dbf9..e8c0d492 100644 --- a/releasenotes/source/index.rst +++ b/releasenotes/source/index.rst @@ -1,5 +1,5 @@ ============================================ - tempest_config Release Notes + python-tempestconf Release Notes ============================================ .. toctree:: diff --git a/test-requirements.txt b/test-requirements.txt index 54bb5d4b..0f769a8a 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -10,6 +10,3 @@ oslotest>=1.10.0 # Apache-2.0 testscenarios>=0.4 # Apache-2.0/BSD testtools>=1.4.0 # MIT stestr>=1.1.0 # Apache-2.0 - -# releasenotes -reno>=1.8.0 # Apache-2.0 diff --git a/tox.ini b/tox.ini index f8646f90..9e9f963f 100644 --- a/tox.ini +++ b/tox.ini @@ -41,6 +41,7 @@ deps = -r{toxinidir}/doc/requirements.txt commands = sphinx-build -b html doc/source doc/build/html [testenv:releasenotes] +deps = -r{toxinidir}/doc/requirements.txt commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html