81 lines
2.8 KiB
Python
81 lines
2.8 KiB
Python
# 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", "sphinx.ext.intersphinx", "oslosphinx"]
|
|
|
|
# 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"syntribos"
|
|
copyright = u"2015-present, OpenStack Foundation"
|
|
|
|
# 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 man page output --------------------------------------------
|
|
|
|
# Grouping the document tree for man pages.
|
|
# List of tuples "sourcefile", "target", u"title", u"Authors name", "manual"
|
|
|
|
man_pages = [("man/syntribos", "syntribos",
|
|
u"Automated API security testing tool",
|
|
[u"OpenStack Security Group"], 1)]
|
|
|
|
# -- 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_options = {}
|
|
|
|
# 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, u"%s Documentation" % project,
|
|
u"OpenStack Foundation", "manual"), ]
|
|
|
|
# Example configuration for intersphinx: refer to the Python standard library.
|
|
# intersphinx_mapping = {"http://docs.python.org/": None}
|
|
intersphinx_mapping = {
|
|
"requests": ("http://docs.python-requests.org/en/master", None)
|
|
}
|