diff --git a/doc/requirements.txt b/doc/requirements.txt index 1afc73d..ea22c4a 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,7 +1,7 @@ # The order of packages is significant, because pip processes them in the order # of appearance. Changing the order has an impact on the overall integration # process, which may cause wedges in the gate later. -openstackdocstheme>=1.18.1 # Apache-2.0 -reno>=2.5.0 # Apache-2.0 -sphinx!=1.6.6,!=1.6.7,>=1.6.5 # BSD +openstackdocstheme>=2.2.1 # Apache-2.0 +reno>=3.1.0 # Apache-2.0 +sphinx>=2.0.0,!=2.1.0 # BSD sphinxcontrib-apidoc>=0.2.0 # BSD diff --git a/doc/source/conf.py b/doc/source/conf.py index 8e5ce4a..4575a5b 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -15,9 +15,6 @@ import os import sys -import openstackdocstheme -import pbr.version - # NOTE(blk-u): Path for our Sphinx extension, remove when # https://launchpad.net/bugs/1260495 is fixed. sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '..'))) @@ -37,10 +34,9 @@ extensions = ['sphinx.ext.autodoc', ] # openstackdocstheme options -repository_name = 'openstack/osc-lib' -bug_project = 'python-openstackclient' -bug_tag = 'osc-lib' -html_last_updated_fmt = '%Y-%m-%d %H:%M' +openstackdocs_repo_name = 'openstack/osc-lib' +openstackdocs_auto_name = False +openstackdocs_use_storyboard = True # Add any paths that contain templates here, relative to this directory. #templates_path = ['_templates'] @@ -57,17 +53,6 @@ master_doc = 'index' # General information about the project. project = u'OpenStackClient CLI Base' -# 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. -# -version_info = pbr.version.VersionInfo('osc-lib') -# -# The short X.Y version. -version = version_info.version_string() -# The full version, including alpha/beta/rc tags. -release = version_info.release_string() - # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. #language = None @@ -98,7 +83,7 @@ exclude_patterns = [] #show_authors = False # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = 'native' # A list of ignored prefixes for module index sorting. modindex_common_prefix = ['osc_lib.'] @@ -117,10 +102,6 @@ html_theme = 'openstackdocs' # documentation. #html_theme_options = {} -# 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 # " v documentation". #html_title = None diff --git a/lower-constraints.txt b/lower-constraints.txt index c7fc19c..0cd4fc4 100644 --- a/lower-constraints.txt +++ b/lower-constraints.txt @@ -42,7 +42,6 @@ msgpack-python==0.4.0 munch==2.1.0 netaddr==0.7.18 netifaces==0.10.4 -openstackdocstheme==1.18.1 openstacksdk==0.15.0 os-service-types==1.2.0 os-testr==1.0.0 @@ -75,7 +74,6 @@ python-mimeparse==1.6.0 python-subunit==1.0.0 pytz==2013.6 PyYAML==3.12 -reno==2.5.0 repoze.lru==0.7 requests==2.14.2 requests-mock==1.1.0 @@ -85,8 +83,6 @@ Routes==2.3.1 simplejson==3.5.1 smmap==0.9.0 snowballstemmer==1.2.1 -Sphinx==1.6.2 -sphinxcontrib-websupport==1.0.1 statsd==3.2.1 stestr==1.0.0 stevedore==1.20.0 diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index a86ad5a..0a0f294 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -27,8 +27,6 @@ # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. -import openstackdocstheme - # sys.path.insert(0, os.path.abspath('.')) # -- General configuration ------------------------------------------------ @@ -43,6 +41,7 @@ import openstackdocstheme extensions = [ 'reno.sphinxext', 'sphinx.ext.extlinks', + 'openstackdocstheme', ] # Set aliases for extlinks @@ -84,6 +83,11 @@ master_doc = 'index' project = u'osc-lib Release Notes' copyright = u'2016, osc-lib Developers' +# openstackdocstheme options +openstackdocs_repo_name = 'openstack/osc-lib' +openstackdocs_auto_name = False +openstackdocs_use_storyboard = True + # Release notes do not need a version in the title, they span # multiple versions. # The full version, including alpha/beta/rc tags. @@ -132,7 +136,7 @@ exclude_patterns = [] # show_authors = False # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = 'native' # A list of ignored prefixes for module index sorting. # modindex_common_prefix = [] @@ -152,10 +156,6 @@ html_theme = 'openstackdocs' # # html_theme_options = {} -# 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 # " v documentation". # html_title = None @@ -186,12 +186,6 @@ html_static_path = ['_static'] # # html_extra_path = [] -# If not None, a 'Last updated on:' timestamp is inserted at every page -# bottom, using the given strftime format. -# The empty string is equivalent to '%b %d, %Y'. -# -# html_last_updated_fmt = '%b %d, %Y' - # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. # diff --git a/test-requirements.txt b/test-requirements.txt index b2a7a62..55e387b 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -7,14 +7,9 @@ coverage!=4.4,>=4.0 # Apache-2.0 fixtures>=3.0.0 # Apache-2.0/BSD oslotest>=3.2.0 # Apache-2.0 requests-mock>=1.1.0 # Apache-2.0 -sphinx!=1.6.6,>=1.6.2 # BSD os-testr>=1.0.0 # Apache-2.0 testrepository>=0.0.18 # Apache-2.0/BSD testtools>=2.2.0 # MIT osprofiler>=1.4.0 # Apache-2.0 bandit>=1.1.0 # Apache-2.0 flake8-import-order>=0.17.1 # LGPLv3 - -# Documentation -openstackdocstheme>=1.18.1 # Apache-2.0 -reno>=2.5.0 # Apache-2.0