From de178ac4382716cc93022be06b93697936e816fc Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Mon, 18 May 2020 21:40:41 +0200 Subject: Switch to newer openstackdocstheme and reno versions Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using these versions will allow especially: * Linking from HTML to PDF document * Allow parallel building of documents * Fix some rendering problems Update Sphinx version as well. Remove docs requirements from lower-constraints, they are not needed during install or test but only for docs building. openstackdocstheme renames some variables, so follow the renames before the next release removes them. A couple of variables are also not needed anymore, remove them. Change pygments_style to 'native' since old theme version always used 'native' and the theme now respects the setting and using 'sphinx' can lead to some strange rendering. See also http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html Change-Id: Ie4aec288c74b9bd8d8d117f4bc2e0282cea4db90 --- doc/requirements.txt | 6 +++--- doc/source/conf.py | 13 ++++--------- lower-constraints.txt | 4 ---- releasenotes/source/conf.py | 14 +++++++------- 4 files changed, 14 insertions(+), 23 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index e8ba0fa..97c1879 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.20.0 # Apache-2.0 -reno>=2.5.0 # Apache-2.0 -sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2 # 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 74d6595..bfe9b56 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -16,7 +16,6 @@ import os import sys -import openstackdocstheme sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '..', '..'))) @@ -39,9 +38,9 @@ apidoc_excluded_paths = [ apidoc_separate_modules = True # openstackdocstheme options -repository_name = 'openstack/python-glanceclient' -bug_project = 'python-glanceclient' -bug_tag = '' +openstackdocs_repo_name = 'openstack/python-glanceclient' +openstackdocs_bug_project = 'python-glanceclient' +openstackdocs_bug_tag = '' # autodoc generation is a bit aggressive and a nuisance when doing heavy # text edit cycles. @@ -68,7 +67,7 @@ add_function_parentheses = True add_module_names = True # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = 'native' # -- Options for HTML output -------------------------------------------------- @@ -77,10 +76,6 @@ pygments_style = 'sphinx' #html_theme = 'nature' html_theme = 'openstackdocs' -# Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = ['_theme'] -html_theme_path = [openstackdocstheme.get_html_theme_path()] - # Output file base name for HTML help builder. htmlhelp_basename = '%sdoc' % project diff --git a/lower-constraints.txt b/lower-constraints.txt index ecb84ad..d98e40b 100644 --- a/lower-constraints.txt +++ b/lower-constraints.txt @@ -31,7 +31,6 @@ monotonic==0.6 msgpack-python==0.4.0 netaddr==0.7.18 netifaces==0.10.4 -openstackdocstheme==1.20.0 ordereddict==1.1 os-client-config==1.28.0 os-testr==1.0.0 @@ -57,15 +56,12 @@ python-mimeparse==1.6.0 python-subunit==1.0.0 pytz==2013.6 PyYAML==3.12 -reno==2.5.0 requests-mock==1.2.0 requests==2.14.2 requestsexceptions==1.2.0 rfc3986==0.3.1 six==1.10.0 snowballstemmer==1.2.1 -Sphinx==1.6.2 -sphinxcontrib-websupport==1.0.1 stestr==2.0.0 stevedore==1.20.0 tempest==17.1.0 diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 75aab4d..d20e2f4 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -29,8 +29,6 @@ # documentation root, use os.path.abspath to make it absolute, like shown here. # sys.path.insert(0, os.path.abspath('.')) -import openstackdocstheme - # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. @@ -41,6 +39,7 @@ import openstackdocstheme # ones. extensions = [ 'reno.sphinxext', + 'openstackdocstheme' ] # Add any paths that contain templates here, relative to this directory. @@ -59,6 +58,11 @@ master_doc = 'index' project = u'glanceclient Release Notes' copyright = u'2016, Glance Developers' +openstackdocs_repo_name = 'openstack/python-glanceclient' +openstackdocs_bug_project = 'python-glanceclient' +openstackdocs_bug_tag = '' +openstackdocs_auto_name = False + # Release notes are not versioned, so we don't need to set version or release version = '' release = '' @@ -93,7 +97,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 = [] @@ -113,10 +117,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 -- cgit v1.2.1