From 6d05fa87e315512d664d6da197e9e019661a6e76 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Sat, 24 Nov 2018 18:51:08 +0100 Subject: [PATCH] Update openstackdocstheme, use Storyboard Require current openstackdocstheme for building - and remove now obsolete options from conf.py. The repo is now handled in storyboard, so update the settings for storyboard. Also, update bug reporting instructions in preface for this. Change-Id: Ieaa1cda7e5fe593fd749985fb6d06b671d64ebec --- doc/requirements.txt | 2 +- doc/source/conf.py | 25 ++----------------------- doc/source/preface.rst | 8 +++----- 3 files changed, 6 insertions(+), 29 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index d68d1264..6912fc36 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,6 +1,6 @@ # 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 +openstackdocstheme>=1.27.1 # Apache-2.0 doc8>=0.6.0 # Apache-2.0 sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD diff --git a/doc/source/conf.py b/doc/source/conf.py index 6a64130c..51fb5f79 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -53,9 +53,7 @@ master_doc = 'index' # General information about the project. repository_name = "openstack/operations-guide" -bug_project = 'openstack-manuals' -project = u'Operations Guide' -bug_tag = u'ops-guide' +use_storyboard = True copyright = u'2016-present, OpenStack contributors' # The language for content autogenerated by Sphinx. Refer to documentation @@ -142,7 +140,7 @@ html_theme = 'openstackdocs' # So that we can enable "log-a-bug" links from each output HTML page, this # variable must be set to a format that includes year, month, day, hours and # minutes. -html_last_updated_fmt = '%Y-%m-%d %H:%M' +# html_last_updated_fmt = '%Y-%m-%d %H:%M' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. @@ -196,25 +194,6 @@ latex_custom_template = r""" \usepackage{%s} """ % (openstack_logo, pdf_theme_path) -latex_engine = 'xelatex' - -latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - 'papersize': 'a4paper', - - # The font size ('10pt', '11pt' or '12pt'). - 'pointsize': '11pt', - - #Default figure align - 'figure_align': 'H', - - # Not to generate blank page after chapter - 'classoptions': ',openany', - - # Additional stuff for the LaTeX preamble. - 'preamble': latex_custom_template, -} - # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). diff --git a/doc/source/preface.rst b/doc/source/preface.rst index cf187ab4..121af33a 100644 --- a/doc/source/preface.rst +++ b/doc/source/preface.rst @@ -402,9 +402,7 @@ Documentation Contributor Guide `_. If you find a bug and can't fix it or aren't sure it's really a doc bug, -log a bug at `OpenStack -Manuals `_. Tag the bug -under Extra options with the ``ops-guide`` tag to indicate that the bug -is in this guide. You can assign the bug to yourself if you know how to -fix it. Also, a member of the OpenStack doc-core team can triage the doc +log a bug in ` +Storyboard `_. You can assign the bug to yourself if you know how to +fix it. Also, a member of the OpenStack operations-doc team can triage the doc bug.