d74ca437b4
This commit updates the document structure to fix both HTML and PDF versions. Some minor fixes are also included. * doc/source/conf.py: Specify openany and oneside as extra class options for LaTeX. * doc/source/conf.py: Specify the depth of TOC for PDF. * Create a separate top page for "Archived Contents" * Adjust the content of doc/source/contributor/index.rst to avoid unnecessary subsection. * Drop strings from the top page as they leads to separate pages in the PDF file. * Add "T.B.D." comments to placeholder documents. * CONTRIBUTING.rst: Remove unnecessary markups for quoting texts. * doc/source/parameters.rst: Update the mailing list link. Story: 2006099 Task: 35137 Change-Id: I5fc03cd8ba53df58ee75e1c1bac4e906f840ec4e
89 lines
2.7 KiB
Python
Executable File
89 lines
2.7 KiB
Python
Executable File
# -*- coding: utf-8 -*-
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
# implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
import os
|
|
import sys
|
|
|
|
sys.path.insert(0, os.path.abspath('../..'))
|
|
# -- General configuration ----------------------------------------------------
|
|
|
|
# Add any Sphinx extension module names here, as strings. They can be
|
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
|
extensions = [
|
|
'sphinx.ext.autodoc',
|
|
'openstackdocstheme',
|
|
#'sphinx.ext.intersphinx',
|
|
]
|
|
|
|
# autodoc generation is a bit aggressive and a nuisance when doing heavy
|
|
# text edit cycles.
|
|
# execute "export SPHINX_DEBUG=1" in your terminal to disable
|
|
|
|
# The suffix of source filenames.
|
|
source_suffix = '.rst'
|
|
|
|
# The master toctree document.
|
|
master_doc = 'index'
|
|
|
|
# General information about the project.
|
|
project = u'os-ken'
|
|
copyright = u'2018, OpenStack Developers'
|
|
|
|
# openstackdocstheme options
|
|
repository_name = 'openstack/os-ken'
|
|
bug_project = 'neutron'
|
|
bug_tag = ''
|
|
html_last_updated_fmt = '%Y-%m-%d %H:%M'
|
|
|
|
# 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
|
|
|
|
# The name of the Pygments (syntax highlighting) style to use.
|
|
pygments_style = 'sphinx'
|
|
|
|
# -- Options for HTML output --------------------------------------------------
|
|
|
|
# The theme to use for HTML and HTML Help pages. Major themes that come with
|
|
# Sphinx are currently 'default' and 'sphinxdoc'.
|
|
# html_theme_path = ["."]
|
|
# html_theme = '_theme'
|
|
# html_static_path = ['static']
|
|
html_theme = 'openstackdocs'
|
|
|
|
# Output file base name for HTML help builder.
|
|
htmlhelp_basename = '%sdoc' % project
|
|
|
|
# -- Options for LaTeX output -------------------------------------------------
|
|
|
|
# Grouping the document tree into LaTeX files. List of tuples
|
|
# (source start file, target name, title, author, documentclass
|
|
# [howto/manual]).
|
|
latex_documents = [
|
|
('index',
|
|
'doc-%s.tex' % project,
|
|
u'%s Documentation' % project,
|
|
u'OpenStack Developers', 'manual'),
|
|
]
|
|
|
|
latex_use_xindy = False
|
|
|
|
latex_elements = {
|
|
'extraclassoptions': 'openany,oneside',
|
|
'preamble': r'\setcounter{tocdepth}{2}',
|
|
}
|