From c603b4613af4884e2ded9d13094c00d6ae92d309 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Sat, 30 May 2020 16:19:12 +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. 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. 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. See also http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html Add docs building job so that this can merge. Change-Id: I7f4ca3a53f5f6266e525d9430d79c0bcee359477 --- .zuul.yaml | 5 +++++ doc/requirements.txt | 6 +++--- doc/source/conf.py | 12 +++++------- releasenotes/source/conf.py | 24 +++++------------------- 4 files changed, 18 insertions(+), 29 deletions(-) create mode 100644 .zuul.yaml diff --git a/.zuul.yaml b/.zuul.yaml new file mode 100644 index 0000000..307250a --- /dev/null +++ b/.zuul.yaml @@ -0,0 +1,5 @@ +- project: + templates: + - build-openstack-docs-pti + gate: + queue: barbican diff --git a/doc/requirements.txt b/doc/requirements.txt index f696fb1..f34464e 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -8,7 +8,7 @@ # # Requirements for docs mock>=2.0.0 # BSD -openstackdocstheme>=1.18.1 # Apache-2.0 -reno>=2.5.0 # Apache-2.0 -sphinx!=1.6.6,!=1.6.7,>=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 5726f33..c67851a 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -115,7 +115,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 = [] @@ -137,9 +137,10 @@ apidoc_excluded_paths = [ html_theme = 'openstackdocs' # openstackdocstheme options -repository_name = 'openstack/barbican-ui' -bug_project = 'barbican-ui' -bug_tag = '' +openstackdocs_repo_name = 'openstack/barbican-ui' +openstackdocs_auto_name = False +openstackdocs_bug_project = 'barbican-ui' +openstackdocs_bug_tag = '' # 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 @@ -170,9 +171,6 @@ bug_tag = '' # so a file named "default.css" will overwrite the builtin "default.css". # html_static_path = ['_static'] -# 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 diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 7e7cba2..8df7f8b 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -11,8 +11,6 @@ # See the License for the specific language governing permissions and # limitations under the License. -from barbican_ui import version as ui_ver - # This file is execfile()d with the current directory set to its # containing dir. # @@ -56,16 +54,6 @@ master_doc = 'index' project = u'Barbican UI Release Notes' copyright = u'2017, OpenStack Foundation' -# 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. -# -# The short X.Y version. -# The full version, including alpha/beta/rc tags. -release = ui_ver.version_info.release_string() -# The short X.Y version. -version = ui_ver.version_info.version_string() - # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # language = None @@ -96,7 +84,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 = [] @@ -112,9 +100,10 @@ pygments_style = 'sphinx' html_theme = 'openstackdocs' # openstackdocstheme options -repository_name = 'openstack/barbican-ui' -bug_project = 'barbican-ui' -bug_tag = '' +openstackdocs_repo_name = 'openstack/barbican-ui' +openstackdocs_auto_name = False +openstackdocs_bug_project = 'barbican-ui' +openstackdocs_bug_tag = '' # 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 @@ -150,9 +139,6 @@ bug_tag = '' # directly to the root of the documentation. # html_extra_path = [] -# 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