a3acb4efb0
This change was created using the OpenStack cookiecutter. A few changes
were made to the cookiecutter output, including removing the python
module structure.
Next, the Ansible collection directory structure was initiatilised via:
ansible-galaxy collection init openstack.kolla
galaxy.yml has been updated to add project metadata.
Some of the basic repository content has been adapted from
kolla-ansible.
The documentation has been cleansed of boilerplate, and the contributor
guide initialised.
CI jobs for docs have been added.
Change-Id: I09ab26b9383d3d415bba735fc0d72e7c88a288b4
80 lines
2.3 KiB
Python
Executable File
80 lines
2.3 KiB
Python
Executable File
# Copyright StackHPC Ltd. All Rights Reserved.
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
import os
|
|
import sys
|
|
|
|
import openstackdocstheme
|
|
|
|
|
|
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 = [
|
|
'openstackdocstheme',
|
|
'sphinx.ext.autodoc',
|
|
'sphinxcontrib.rsvgconverter',
|
|
]
|
|
|
|
# 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'ansible-collection-kolla'
|
|
copyright = u'2017, OpenStack Developers'
|
|
|
|
# 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 = 'native'
|
|
|
|
# -- 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
|
|
|
|
# Grouping the document tree into LaTeX files. List of tuples
|
|
# (source start file, target name, title, author, documentclass
|
|
# [howto/manual]).
|
|
latex_documents = [
|
|
('index',
|
|
'%s.tex' % project,
|
|
'%s Documentation' % project,
|
|
'OpenStack Foundation', 'manual'),
|
|
]
|
|
|
|
# Disable usage of xindy https://bugzilla.redhat.com/show_bug.cgi?id=1643664
|
|
latex_use_xindy = False
|
|
|
|
# openstackdocstheme options
|
|
openstackdocs_repo_name = 'openstack/ansible-collection-kolla'
|
|
openstackdocs_pdf_link = True
|
|
openstackdocs_bug_project = 'ansible-collection-kolla'
|
|
openstackdocs_bug_tag = ''
|
|
|
|
openstackdocs_projects = [
|
|
'kolla-ansible',
|
|
]
|
|
|