Update docs config for storyboard bugs

This patch updates the docs configuration to have bugs links that take the
reporter to storyboad instead of launchpad.
It also sets the docs up for PDF rendering and multiple versions of the
documentation.

Change-Id: I66187e09e038efe605db45a26e3505218a7a4c65
This commit is contained in:
Michael Johnson 2018-02-01 17:18:13 -08:00
parent d1693c523b
commit ee00bfe50e
3 changed files with 36 additions and 6 deletions

View File

@ -25,6 +25,8 @@
import os
import sys
import openstackdocstheme
from octavia.version import version_info
extensions = [
@ -39,7 +41,7 @@ html_theme_options = {
"sidebar_mode": "toc"
}
repository_name = 'openstack/octavia'
bug_project = 'octavia'
bug_project = '908'
bug_tag = 'api-ref'
@ -192,6 +194,14 @@ htmlhelp_basename = 'octaviadoc'
# -- Options for LaTeX output -------------------------------------------------
pdf_theme_path = openstackdocstheme.get_pdf_theme_path()
openstack_logo = openstackdocstheme.get_openstack_logo_path()
latex_custom_template = r"""
\newcommand{\openstacklogo}{%s}
\usepackage{%s}
""" % (openstack_logo, pdf_theme_path)
# The paper size ('letter' or 'a4').
# latex_paper_size = 'letter'
@ -206,6 +216,14 @@ latex_documents = [
u'OpenStack Foundation', 'manual'),
]
latex_elements = {
# ...
# Additional stuff for the LaTeX preamble.
'preamble': latex_custom_template,
}
latex_engine = 'xelatex'
# The name of an image file (relative to this directory) to place at the top of
# the title page.
# latex_logo = None

View File

@ -15,6 +15,7 @@
import os
import sys
import openstackdocstheme
from pydotplus import graphviz
import sadisplay
from sphinx import apidoc
@ -137,6 +138,7 @@ html_theme = 'openstackdocs'
# further. For a list of options available for each theme, see the
# documentation.
# html_theme_options = {}
html_theme_options = {'show_other_versions': True}
# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = []
@ -206,6 +208,14 @@ htmlhelp_basename = 'Octavia-Specsdoc'
# -- Options for LaTeX output -------------------------------------------------
pdf_theme_path = openstackdocstheme.get_pdf_theme_path()
openstack_logo = openstackdocstheme.get_openstack_logo_path()
latex_custom_template = r"""
\newcommand{\openstacklogo}{%s}
\usepackage{%s}
""" % (openstack_logo, pdf_theme_path)
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
# 'papersize': 'letterpaper',
@ -214,7 +224,7 @@ latex_elements = {
# 'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
# 'preamble': '',
'preamble': latex_custom_template,
}
# Grouping the document tree into LaTeX files. List of tuples
@ -222,12 +232,14 @@ latex_elements = {
# [howto/manual]).
latex_documents = [(
'index',
'Octavia-specs.tex',
u'Octavia Specs',
'Octavia.tex',
u'Octavia Documentation',
u'OpenStack Octavia Team',
'manual'
)]
latex_engine = 'xelatex'
# The name of an image file (relative to this directory) to place at the top of
# the title page.
# latex_logo = None
@ -324,7 +336,7 @@ html_theme_options = {
'display_toc': False
}
repository_name = 'openstack/octavia'
bug_project = 'octavia'
bug_project = '908'
bug_tag = 'docs'

View File

@ -44,7 +44,7 @@ extensions = [
# openstackdocstheme options
repository_name = 'openstack/octavia'
bug_project = 'octavia'
bug_project = '908'
bug_tag = 'doc'
# Add any paths that contain templates here, relative to this directory.