From ed34d20c38cd5c14b39ad4ffa329846c9cbd3341 Mon Sep 17 00:00:00 2001 From: Akihiro Motoki Date: Thu, 6 Jul 2017 20:45:58 +0000 Subject: [PATCH] switch from oslosphinx to openstackdocstheme Fixes formatting things related to openstackdocstheme adoption Change-Id: I05a794b806c36b5237fc9a1b6eabaaff802aba0e --- CONTRIBUTING.rst | 9 +++------ doc/source/conf.py | 12 ++++++++++-- releasenotes/source/conf.py | 11 ++++++++--- releasenotes/source/index.rst | 8 ++++---- test-requirements.txt | 2 +- 5 files changed, 26 insertions(+), 16 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 0b43e12..a060f42 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,16 +1,13 @@ If you would like to contribute to the development of OpenStack, you must follow the steps in this page: - - http://docs.openstack.org/infra/manual/developers.html +http://docs.openstack.org/infra/manual/developers.html Once those steps have been completed, changes to OpenStack should be submitted for review via the Gerrit tool, following the workflow documented at: - - http://docs.openstack.org/infra/manual/developers.html#development-workflow +http://docs.openstack.org/infra/manual/developers.html#development-workflow Pull requests submitted through GitHub will be ignored. Bugs should be filed on Launchpad, not GitHub: - - https://bugs.launchpad.net/oslo.serialization +https://bugs.launchpad.net/oslo.serialization diff --git a/doc/source/conf.py b/doc/source/conf.py index 409a889..0b2f28c 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -23,9 +23,14 @@ sys.path.insert(0, os.path.abspath('../..')) extensions = [ 'sphinx.ext.autodoc', #'sphinx.ext.intersphinx', - 'oslosphinx' + 'openstackdocstheme' ] +# openstackdocstheme options +repository_name = 'openstack/oslo.serialization' +bug_project = 'oslo.serialization' +bug_tag = '' + # 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 @@ -57,6 +62,9 @@ pygments_style = 'sphinx' # html_theme_path = ["."] # html_theme = '_theme' # html_static_path = ['static'] +html_theme = 'openstackdocs' + +html_last_updated_fmt = '%Y-%m-%d %H:%M' # Output file base name for HTML help builder. htmlhelp_basename = '%sdoc' % project @@ -72,4 +80,4 @@ latex_documents = [ ] # Example configuration for intersphinx: refer to the Python standard library. -#intersphinx_mapping = {'http://docs.python.org/': None} \ No newline at end of file +#intersphinx_mapping = {'http://docs.python.org/': None} diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 32af56c..15923cf 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -35,10 +35,15 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'oslosphinx', + 'openstackdocstheme', 'reno.sphinxext', ] +# openstackdocstheme options +repository_name = 'openstack/oslo.serialization' +bug_project = 'oslo.serialization' +bug_tag = '' + # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -109,7 +114,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 @@ -147,7 +152,7 @@ html_static_path = ['_static'] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. -# html_last_updated_fmt = '%b %d, %Y' +html_last_updated_fmt = '%Y-%m-%d %H:%M' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst index 7fb8b6a..d1fc7bb 100644 --- a/releasenotes/source/index.rst +++ b/releasenotes/source/index.rst @@ -2,8 +2,8 @@ oslo.serialization Release Notes ================================== - .. toctree:: - :maxdepth: 1 +.. toctree:: + :maxdepth: 1 - unreleased - ocata + unreleased + ocata diff --git a/test-requirements.txt b/test-requirements.txt index 737815a..54f69cc 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -8,7 +8,7 @@ netaddr!=0.7.16,>=0.7.13 # BSD # this is required for the docs build jobs sphinx>=1.6.2 # BSD -oslosphinx>=4.7.0 # Apache-2.0 +openstackdocstheme>=1.11.0 # Apache-2.0 oslotest>=1.10.0 # Apache-2.0 oslo.i18n!=3.15.2,>=2.1.0 # Apache-2.0