From 55c0663465cf51e2be699a07bbb7eb53bf838911 Mon Sep 17 00:00:00 2001 From: Nguyen Hai Date: Wed, 16 May 2018 15:56:30 +0900 Subject: [PATCH] Switch from oslosphinx to openstackdocstheme openstackdocstheme is a theme and extension support for Sphinx documentation that is published to docs.openstack.org and developer.openstack.org. Change-Id: Iaa40faa4292c2626b4e3344112eac4b806cfa6e7 --- doc/source/conf.py | 8 ++------ doc/source/index.rst | 5 +++-- lower-constraints.txt | 1 + test-requirements.txt | 4 ++-- 4 files changed, 8 insertions(+), 10 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index d5d91895..a7baede3 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -21,8 +21,7 @@ sys.path.insert(0, os.path.abspath('../..')) # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = [ 'sphinx.ext.autodoc', - #'sphinx.ext.intersphinx', - 'oslosphinx' + 'openstackdocstheme' ] # autodoc generation is a bit aggressive and a nuisance when doing heavy @@ -52,10 +51,7 @@ pygments_style = 'sphinx' # -- Options for HTML output -------------------------------------------------- # The theme to use for HTML and HTML Help pages. Major themes that come with -# Sphinx are currently 'default' and 'sphinxdoc'. -# html_theme_path = ["."] -# html_theme = 'default' -# html_static_path = ['static'] +html_theme = 'openstackdocs' # Output file base name for HTML help builder. htmlhelp_basename = '%sdoc' % project diff --git a/doc/source/index.rst b/doc/source/index.rst index c3894f49..1067ef12 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -4,7 +4,7 @@ contain the root `toctree` directive. Welcome to tosca-parser's documentation! -=========================================== +======================================== The TOSCA Parser is developed to parse TOSCA Simple Profile in YAML. It reads the TOSCA templates and creates an in-memory graph of TOSCA nodes and their @@ -22,6 +22,7 @@ creating a module in the "toscaparser/extensions" directory. See the "nfv" module for an example. Contents: +--------- .. toctree:: :maxdepth: 2 @@ -31,7 +32,7 @@ Contents: contributing Indices and tables -================== +------------------ * :ref:`genindex` * :ref:`modindex` diff --git a/lower-constraints.txt b/lower-constraints.txt index 720bdb11..f1452584 100644 --- a/lower-constraints.txt +++ b/lower-constraints.txt @@ -18,6 +18,7 @@ MarkupSafe==1.0 mccabe==0.2.1 mock==2.0.0 mox3==0.20.0 +openstackdocstheme==1.18.1 os-client-config==1.28.0 oslosphinx==4.7.0 oslotest==3.2.0 diff --git a/test-requirements.txt b/test-requirements.txt index adf41b80..7091256b 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -5,9 +5,9 @@ hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0 coverage!=4.4,>=4.0 # Apache-2.0 fixtures>=3.0.0 # Apache-2.0/BSD oslotest>=3.2.0 # Apache-2.0 -oslosphinx>=4.7.0 # Apache-2.0 +openstackdocstheme>=1.18.1 # Apache-2.0 python-subunit>=1.0.0 # Apache-2.0/BSD -sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD +sphinx!=1.6.6,!=1.6.7,>=1.6.5 # BSD testrepository>=0.0.18 # Apache-2.0/BSD testscenarios>=0.4 # Apache-2.0/BSD testtools>=2.2.0 # MIT