From 4b52d4d458d3fbd7830e8a1935c4af25a95cf13d Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Thu, 21 May 2020 12:48:08 +0200 Subject: [PATCH] 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. Set openstackdocs_pdf_link to link to PDF file. Note that the link to the published document only works on docs.openstack.org where the PDF file is placed in the top-level html directory. The site-preview places the PDF in a pdf directory. Disable openstackdocs_auto_name to use 'project' variable as name. 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. 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. Remove python 3 versioning from lower-constraints and requirements to pass requirements-check. See also http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html Change-Id: Id478711abb1783422ebb4ee9937d1b7202fdf2f3 --- api-ref/source/conf.py | 18 +----------------- doc/requirements.txt | 6 +++--- doc/source/conf.py | 10 ++++++---- lower-constraints.txt | 8 +------- releasenotes/source/conf.py | 14 +++++--------- requirements.txt | 3 +-- 6 files changed, 17 insertions(+), 42 deletions(-) diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py index 1c33ca758..63ac5dc82 100644 --- a/api-ref/source/conf.py +++ b/api-ref/source/conf.py @@ -12,7 +12,6 @@ # limitations under the License. import os -import subprocess import sys @@ -56,13 +55,6 @@ master_doc = 'index' project = u'Workflow Service API Reference' copyright = u'2017, Mistral Contributors' -# 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. -from mistral.version import version_info -release = version_info.release_string() -version = version_info.version_string() - # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. show_authors = False @@ -75,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 -------------------------------------------------- @@ -93,14 +85,6 @@ htmlhelp_basename = '%sdoc' % project # A list of ignored prefixes for module index sorting. modindex_common_prefix = ['mistral.'] -# 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' -git_cmd = ["git", "log", "--pretty=format:'%ad, commit %h'", "--date=local", - "-n1"] -html_last_updated_fmt = subprocess.check_output( - git_cmd).decode('utf-8') - # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". html_title = 'Mistral API Reference' diff --git a/doc/requirements.txt b/doc/requirements.txt index a918df6bc..595c1838f 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,6 +1,6 @@ -sphinx>=1.8.0,!=2.1.0,!=3.0.0;python_version>='3.4' # BSD +sphinx>=2.0.0,!=2.1.0 # BSD sphinxcontrib-httpdomain>=1.3.0 # BSD sphinxcontrib-pecanwsme>=0.8.0 # Apache-2.0 -openstackdocstheme>=1.30.0 # Apache-2.0 +openstackdocstheme>=2.2.1 # Apache-2.0 os-api-ref>=1.4.0 # Apache-2.0 -reno>=2.5.0 # Apache-2.0 +reno>=3.1.0 # Apache-2.0 diff --git a/doc/source/conf.py b/doc/source/conf.py index 5a7b51271..af61bd7ae 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -74,7 +74,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 -------------------------------------------------- @@ -105,9 +105,11 @@ man_show_urls = True # -- Options for openstackdocstheme ------------------------------------------- -repository_name = 'openstack/mistral' -bug_project = 'mistral' -bug_tag = 'doc' +openstackdocs_repo_name = 'openstack/mistral' +openstackdocs_pdf_link = True +openstackdocs_auto_name = False +openstackdocs_bug_project = 'mistral' +openstackdocs_bug_tag = 'doc' latex_use_xindy = False diff --git a/lower-constraints.txt b/lower-constraints.txt index 170894744..1b54a54f4 100644 --- a/lower-constraints.txt +++ b/lower-constraints.txt @@ -13,8 +13,7 @@ keystonemiddleware==4.18.0 kombu==4.6.1 mistral-lib==1.4.0 mock==2.0.0 -networkx==2.3;python_version>='3.4' -networkx==1.10;python_version<'3.0' +networkx==2.3 nose==1.3.7 oslo.concurrency==3.26.0 oslo.config==5.2.0 @@ -37,14 +36,9 @@ pecan==1.2.1 Pygments==2.2.0 PyJWT==1.5 PyYAML==5.1 -reno==2.5.0 requests-mock==1.2.0 requests==2.14.2 six==1.10.0 -Sphinx==1.8.0 -sphinxcontrib-httpdomain==1.3.0 -sphinxcontrib-pecanwsme==0.10.0 -sphinxcontrib-websupport==1.0.1 SQLAlchemy==1.2.5 stestr==2.0.0 stevedore==1.20.0 diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index ea5066d97..670f7525c 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -92,7 +92,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 = [] @@ -141,11 +141,6 @@ html_theme = 'openstackdocs' # directly to the root of the documentation. # html_extra_path = [] -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -# Must set this variable to include year, month, day, hours, and minutes. -html_last_updated_fmt = '%Y-%m-%d %H:%M' - # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. # html_use_smartypants = True @@ -270,6 +265,7 @@ texinfo_documents = [ locale_dirs = ['locale/'] # -- Options for openstackdocstheme ------------------------------------------- -repository_name = 'openstack/mistral' -bug_project = 'mistral' -bug_tag = '' +openstackdocs_repo_name = 'openstack/mistral' +openstackdocs_auto_name = False +openstackdocs_bug_project = 'mistral' +openstackdocs_bug_tag = '' diff --git a/requirements.txt b/requirements.txt index e2c1a283e..bccf00768 100644 --- a/requirements.txt +++ b/requirements.txt @@ -13,8 +13,7 @@ jsonschema>=2.6.0 # MIT keystonemiddleware>=4.18.0 # Apache-2.0 kombu!=4.0.2,>=4.6.1 # BSD mistral-lib>=1.4.0 # Apache-2.0 -networkx<2.3,>=1.10;python_version<'3.0' # BSD -networkx>=2.3;python_version>='3.4' # BSD +networkx>=2.3 # BSD oslo.concurrency>=3.26.0 # Apache-2.0 oslo.config>=5.2.0 # Apache-2.0 oslo.context>=2.20.0 # Apache-2.0