trivial: Remove cruft from 'conf.py'
This serves as a reference guide of sorts. No need to keep all the noise around. Change-Id: Id9a636a4e4d7586ad395e2a2eb00b3bc08c61fa2
This commit is contained in:
Stephen Finucane
parent
79b8ccb0d3
commit
191502db2a
@ -1,25 +1,9 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# os-doc-demo documentation build configuration file, created by
|
||||
# sphinx-quickstart on Tue Jan 20 08:22:27 2015.
|
||||
#
|
||||
# This file is execfile()d with the current directory set to its
|
||||
# containing dir.
|
||||
#
|
||||
# Note that not all possible configuration values are present in this
|
||||
# autogenerated file.
|
||||
#
|
||||
# All configuration values have a default; values that are commented out
|
||||
# serve to show the default.
|
||||
|
||||
# import os
|
||||
# openstackdocstheme documentation build configuration file
|
||||
|
||||
import openstackdocstheme
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||
#sys.path.insert(0, os.path.abspath('.'))
|
||||
from openstackdocstheme.version import version_info
|
||||
|
||||
# Release name for PDF documents
|
||||
latex_custom_template = r"""
|
||||
@ -29,13 +13,9 @@ latex_custom_template = r"""
|
||||
|
||||
# -- General configuration ------------------------------------------------
|
||||
|
||||
# If your documentation needs a minimal Sphinx version, state it here.
|
||||
#needs_sphinx = '1.0'
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||
# ones.
|
||||
|
||||
extensions = ['openstackdocstheme']
|
||||
|
||||
# openstackdocstheme options
|
||||
@ -43,15 +23,9 @@ repository_name = 'openstack/openstackdocstheme'
|
||||
bug_project = 'openstack-doc-tools'
|
||||
bug_tag = 'openstackdocstheme'
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
# templates_path = ['_templates']
|
||||
|
||||
# The suffix of source filenames.
|
||||
source_suffix = '.rst'
|
||||
|
||||
# The encoding of source files.
|
||||
#source_encoding = 'utf-8-sig'
|
||||
|
||||
# The master toctree document.
|
||||
master_doc = 'index'
|
||||
|
||||
@ -66,60 +40,18 @@ copyright = u'2015-2017, OpenStack Contributors'
|
||||
# |version| and |release|, also used in various other places throughout the
|
||||
# built documents.
|
||||
#
|
||||
# "version" and "release" are used by the "log-a-bug" feature
|
||||
#
|
||||
# The short X.Y version.
|
||||
#version = '1.0'
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
#release = '1.0'
|
||||
# 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 openstackdocstheme.version import version_info
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = version_info.release_string()
|
||||
# The short X.Y version.
|
||||
version = version_info.version_string()
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
#language = None
|
||||
|
||||
# There are two options for replacing |today|: either, you set today to some
|
||||
# non-false value, then it is used:
|
||||
#today = ''
|
||||
# Else, today_fmt is used as the format for a strftime call.
|
||||
#today_fmt = '%B %d, %Y'
|
||||
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
exclude_patterns = ['_build']
|
||||
|
||||
# The reST default role (used for this markup: `text`) to use for all
|
||||
# documents.
|
||||
#default_role = None
|
||||
|
||||
# If true, '()' will be appended to :func: etc. cross-reference text.
|
||||
#add_function_parentheses = True
|
||||
|
||||
# If true, the current module name will be prepended to all description
|
||||
# unit titles (such as .. function::).
|
||||
#add_module_names = True
|
||||
|
||||
# If true, sectionauthor and moduleauthor directives will be shown in the
|
||||
# output. They are ignored by default.
|
||||
#show_authors = False
|
||||
|
||||
# The name of the Pygments (syntax highlighting) style to use.
|
||||
pygments_style = 'sphinx'
|
||||
|
||||
# A list of ignored prefixes for module index sorting.
|
||||
#modindex_common_prefix = []
|
||||
|
||||
# If true, keep warnings as "system message" paragraphs in the built documents.
|
||||
#keep_warnings = False
|
||||
|
||||
|
||||
# -- Options for HTML output ----------------------------------------------
|
||||
|
||||
@ -136,87 +68,13 @@ html_theme = 'openstackdocs'
|
||||
# variable, sidebar_dropdown, should be set to `api_ref`.
|
||||
# Otherwise, the list of links for the User and Ops docs
|
||||
# appear in the sidebar dropdown menu.
|
||||
#html_theme_options = {"sidebar_dropdown": "api_ref"}
|
||||
html_theme_options = {'show_other_versions': True}
|
||||
|
||||
# Add any paths that contain custom themes here, relative to this directory.
|
||||
# html_theme_path = []
|
||||
|
||||
# The name for this set of Sphinx documents. If None, it defaults to
|
||||
# "<project> v<release> documentation".
|
||||
#html_title = None
|
||||
|
||||
# A shorter title for the navigation bar. Default is the same as html_title.
|
||||
#html_short_title = None
|
||||
|
||||
# The name of an image file (relative to this directory) to place at the top
|
||||
# of the sidebar.
|
||||
#html_logo = None
|
||||
|
||||
# The name of an image file (within the static path) to use as favicon of the
|
||||
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
||||
# pixels large.
|
||||
#html_favicon = None
|
||||
|
||||
# Add any paths that contain custom static files (such as style sheets) here,
|
||||
# relative to this directory. They are copied after the builtin static files,
|
||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
html_static_path = ['_static/css']
|
||||
|
||||
# Add any extra paths that contain custom files (such as robots.txt or
|
||||
# .htaccess) here, relative to this directory. These files are copied
|
||||
# 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.
|
||||
#html_last_updated_fmt = '%b %d, %Y'
|
||||
|
||||
# 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'
|
||||
|
||||
# If true, SmartyPants will be used to convert quotes and dashes to
|
||||
# typographically correct entities.
|
||||
#html_use_smartypants = True
|
||||
|
||||
# Custom sidebar templates, maps document names to template names.
|
||||
#html_sidebars = {}
|
||||
|
||||
# Additional templates that should be rendered to pages, maps page names to
|
||||
# template names.
|
||||
#html_additional_pages = {}
|
||||
|
||||
# If false, no module index is generated.
|
||||
#html_domain_indices = True
|
||||
|
||||
# If false, no index is generated.
|
||||
#html_use_index = True
|
||||
|
||||
# If true, the index is split into individual pages for each letter.
|
||||
#html_split_index = False
|
||||
|
||||
# If true, links to the reST sources are added to the pages.
|
||||
#html_show_sourcelink = True
|
||||
|
||||
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
||||
#html_show_sphinx = True
|
||||
|
||||
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
||||
#html_show_copyright = True
|
||||
|
||||
# If true, an OpenSearch description file will be output, and all pages will
|
||||
# contain a <link> tag referring to it. The value of this option must be the
|
||||
# base URL from which the finished HTML is served.
|
||||
#html_use_opensearch = ''
|
||||
|
||||
# This is the file name suffix for HTML files (e.g. ".xhtml").
|
||||
#html_file_suffix = None
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = 'os-doc-demodoc'
|
||||
|
||||
|
||||
# -- Options for LaTeX output ---------------------------------------------
|
||||
latex_engine = 'xelatex'
|
||||
@ -244,60 +102,3 @@ latex_documents = [
|
||||
('index', 'os-doc-demo.tex', u'os-doc-demo Documentation',
|
||||
u'OpenStack Contributors', 'manual'),
|
||||
]
|
||||
|
||||
# The name of an image file (relative to this directory) to place at the top of
|
||||
# the title page.
|
||||
#latex_logo = None
|
||||
|
||||
# For "manual" documents, if this is true, then toplevel headings are parts,
|
||||
# not chapters.
|
||||
#latex_use_parts = False
|
||||
|
||||
# If true, show page references after internal links.
|
||||
#latex_show_pagerefs = False
|
||||
|
||||
# If true, show URL addresses after external links.
|
||||
#latex_show_urls = False
|
||||
|
||||
# Documents to append as an appendix to all manuals.
|
||||
#latex_appendices = []
|
||||
|
||||
# If false, no module index is generated.
|
||||
#latex_domain_indices = True
|
||||
|
||||
|
||||
# -- Options for manual page output ---------------------------------------
|
||||
|
||||
# One entry per manual page. List of tuples
|
||||
# (source start file, name, description, authors, manual section).
|
||||
man_pages = [
|
||||
('index', 'os-doc-demo', u'os-doc-demo Documentation',
|
||||
[u'OpenStack Contributors'], 1)
|
||||
]
|
||||
|
||||
# If true, show URL addresses after external links.
|
||||
#man_show_urls = False
|
||||
|
||||
|
||||
# -- Options for Texinfo output -------------------------------------------
|
||||
|
||||
# Grouping the document tree into Texinfo files. List of tuples
|
||||
# (source start file, target name, title, author,
|
||||
# dir menu entry, description, category)
|
||||
texinfo_documents = [
|
||||
('index', 'os-doc-demo', u'os-doc-demo Documentation',
|
||||
u'OpenStack Contributors', 'os-doc-demo', 'One line description of project.',
|
||||
'Miscellaneous'),
|
||||
]
|
||||
|
||||
# Documents to append as an appendix to all manuals.
|
||||
#texinfo_appendices = []
|
||||
|
||||
# If false, no module index is generated.
|
||||
#texinfo_domain_indices = True
|
||||
|
||||
# How to display URL addresses: 'footnote', 'no', or 'inline'.
|
||||
#texinfo_show_urls = 'footnote'
|
||||
|
||||
# If true, do not generate a @detailmenu in the "Top" node's menu.
|
||||
#texinfo_no_detailmenu = False
|
||||
|
||||
@ -2,37 +2,35 @@
|
||||
OpenStack docs.openstack.org Sphinx theme
|
||||
===========================================
|
||||
|
||||
``openstackdocstheme`` is a theme and extension support for Sphinx
|
||||
documentation that is published to docs.openstack.org and
|
||||
developer.openstack.org.
|
||||
*openstackdocstheme* is a theme and extension support for Sphinx documentation
|
||||
that is published to docs.openstack.org and developer.openstack.org.
|
||||
|
||||
It is intended for use by OpenStack `projects governed by the
|
||||
Technical Committee`_.
|
||||
It is intended for use by OpenStack `projects governed by the Technical
|
||||
Committee`_.
|
||||
|
||||
.. _`projects governed by the Technical Committee`: https://governance.openstack.org/reference/projects/index.html
|
||||
|
||||
Using the theme
|
||||
===============
|
||||
---------------
|
||||
|
||||
.. note::
|
||||
|
||||
Prior to using this theme, ensure your project can use the
|
||||
OpenStack brand by referring to the brand guidelines at
|
||||
https://www.openstack.org/brand.
|
||||
Prior to using this theme, ensure your project can use the OpenStack brand
|
||||
by referring to the brand guidelines at https://www.openstack.org/brand.
|
||||
|
||||
.. note::
|
||||
|
||||
Some of the settings below are included in the file generated by
|
||||
Sphinx when you initialize a project, so they may already have
|
||||
values that need to be changed.
|
||||
Some of the settings below are included in the file generated by Sphinx when
|
||||
you initialize a project, so they may already have values that need to be
|
||||
changed.
|
||||
|
||||
#. Update the requirements list for your project to include
|
||||
``openstackdocstheme`` (usually in test-requirements.txt).
|
||||
``openstackdocstheme`` (usually in ``test-requirements.txt``).
|
||||
|
||||
#. If your project previously used the oslosphinx theme (without
|
||||
modifying the header navigation), remove ``oslosphinx`` from your
|
||||
requirements list, and then in your ``conf.py`` you can remove the
|
||||
import statement and extension listing for oslosphinx.
|
||||
#. If your project previously used the *oslosphinx* theme (without modifying
|
||||
the header navigation), remove ``oslosphinx`` from your requirements list,
|
||||
and then in your ``conf.py`` you can remove the import statement and
|
||||
extension listing for *oslosphinx*.
|
||||
|
||||
#. Then modify your Sphinx settings in ``conf.py`` to include::
|
||||
|
||||
@ -56,13 +54,11 @@ Using the theme
|
||||
``bug_project``
|
||||
The project name or ID. For launchpad, it's a string like
|
||||
``python-glanceclient``. If your project uses
|
||||
``storyboard.openstack.org``, use the project number instead
|
||||
like ``901``. If unspecified, the "Report a bug" links are
|
||||
not shown.
|
||||
``storyboard.openstack.org``, use the project number instead like
|
||||
``901``. If unspecified, the "Report a bug" links are not shown.
|
||||
|
||||
``bug_tag``
|
||||
Launchpad bug tag. If unspecified, no tag is set. The default is
|
||||
empty.
|
||||
Launchpad bug tag. If unspecified, no tag is set. The default is empty.
|
||||
|
||||
One example for a project using launchpad::
|
||||
|
||||
@ -145,8 +141,9 @@ Using the theme
|
||||
|
||||
latex_engine = 'xelatex'
|
||||
|
||||
|
||||
External Link Helper
|
||||
====================
|
||||
--------------------
|
||||
|
||||
The configuration option ``openstack_projects`` can be used to define
|
||||
custom roles that build links that update automatically when branches
|
||||
@ -172,7 +169,7 @@ Then in the documentation source, link to a target using syntax like:
|
||||
|
||||
|
||||
Demonstration example
|
||||
=====================
|
||||
---------------------
|
||||
|
||||
The demo documentation provides example output to ensure it matches what's
|
||||
expected. The link below points to the example output when using the theme
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user