f81cf9a905
Follow PTI [1] for doc building: * Create doc/requirements.txt file with all docs requirements. * Switch to openstackdocstheme and update conf.py for this. * Move doc8 to pep8 section since it's a linter. Additionally: * Fix all build errors with doc building. * Update requirements list with license info. * Use hacking instead of flake directly. * Remove unused _static files, those are not needed. * Update git URLs, fix contributor guide URL * Move README.md to RST, everything else in this repo is RST * Publish documents to docs.o.o - note that https://adjutant.readthedocs.io/en/latest/ was last updated in March 2018 This adds jobs for building of release notes - only building since there's no content yet - and publishing of documentation. Publishing of api-ref can be done via: https://review.opendev.org/675766 [1] https://governance.openstack.org/tc/reference/project-testing-interface.html#documentation Change-Id: I82f56ef5ea800899b2a8db795b6cf2b21d03ac7a
130 lines
4.0 KiB
Python
130 lines
4.0 KiB
Python
# -*- coding: utf-8 -*-
|
|
#
|
|
# Adjutant documentation build configuration file, created by
|
|
# sphinx-quickstart on Wed Jun 21 13:29:33 2017.
|
|
#
|
|
# 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.
|
|
|
|
# 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.
|
|
#
|
|
# import os
|
|
# import sys
|
|
# sys.path.insert(0, os.path.abspath('.'))
|
|
|
|
|
|
# -- 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'
|
|
]
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
templates_path = ['_templates']
|
|
|
|
# openstackdocstheme settings
|
|
repository_name = 'openstack/adjutant'
|
|
html_theme = 'openstackdocs'
|
|
use_storyboard = True
|
|
|
|
# The suffix(es) of source filenames.
|
|
# You can specify multiple suffix as a list of string:
|
|
#
|
|
# source_suffix = ['.rst', '.md']
|
|
source_suffix = '.rst'
|
|
|
|
# The master toctree document.
|
|
master_doc = 'index'
|
|
|
|
# General information about the project.
|
|
project = u'Adjutant'
|
|
copyright = u'2017, Catalyst IT Ltd'
|
|
|
|
|
|
# List of patterns, relative to source directory, that match files and
|
|
# directories to ignore when looking for source files.
|
|
# This patterns also effect to html_static_path and html_extra_path
|
|
exclude_patterns = []
|
|
|
|
# The name of the Pygments (syntax highlighting) style to use.
|
|
pygments_style = 'sphinx'
|
|
|
|
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
|
todo_include_todos = False
|
|
|
|
|
|
# -- Options for HTML output ----------------------------------------------
|
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
# a list of builtin themes.
|
|
#
|
|
# html_theme = 'sphinx_rtd_theme'
|
|
|
|
# Add any paths that contain custom themes here, relative to this directory.
|
|
# html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
|
|
|
|
# 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
|
|
# documentation.
|
|
#
|
|
# html_theme_options = {}
|
|
|
|
# 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']
|
|
|
|
|
|
# -- Options for HTMLHelp output ------------------------------------------
|
|
|
|
# Output file base name for HTML help builder.
|
|
htmlhelp_basename = 'Adjutantdoc'
|
|
|
|
|
|
# -- Options for LaTeX output ---------------------------------------------
|
|
|
|
# Grouping the document tree into LaTeX files. List of tuples
|
|
# (source start file, target name, title,
|
|
# author, documentclass [howto, manual, or own class]).
|
|
latex_documents = [
|
|
(master_doc, 'Adjutant.tex', u'Adjutant Documentation',
|
|
u'Catalyst IT Ltd', 'manual'),
|
|
]
|
|
|
|
|
|
# -- Options for manual page output ---------------------------------------
|
|
|
|
# One entry per manual page. List of tuples
|
|
# (source start file, name, description, authors, manual section).
|
|
man_pages = [
|
|
(master_doc, 'adjutant', u'Adjutant Documentation',
|
|
['Catalyst IT Ltd'], 1)
|
|
]
|
|
|
|
|
|
# -- 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 = [
|
|
(master_doc, 'Adjutant', u'Adjutant Documentation',
|
|
'Catalyst IT Ltd', 'Adjutant', 'One line description of project.',
|
|
'Miscellaneous'),
|
|
]
|