sysdig-sdk-python/docs/conf.py at master · sysdiglabs/sysdig-sdk-python · GitHub

This repository was archived by the owner on May 7, 2026. It is now read-only.

History

164 lines (133 loc) · 5.37 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

# -*- coding: utf-8 -*-

# python-sdc-client documentation build configuration file, created by

# sphinx-quickstart on Thu Dec 22 11:59:02 2016.

# 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

from datetime import datetime

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 = ['sphinx.ext.autodoc', 'sphinx.ext.autosectionlabel', 'sphinx.ext.graphviz',

'sphinx.ext.inheritance_diagram', 'sphinx.ext.viewcode', 'sphinx.ext.autosummary',

'sphinx.ext.githubpages', 'sphinx.ext.napoleon', 'sphinx_rtd_theme']

# Add any paths that contain templates here, relative to this directory.

templates_path = ['_templates']

# 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'Sysdig SDK for Python'

author = u'Sysdig Inc.'

# 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.

# The short X.Y version.

version = u''

# The full version, including alpha/beta/rc tags.

release = u''

# The language for content autogenerated by Sphinx. Refer to documentation

# for a list of supported languages.

# This is also used if you do content translation via gettext catalogs.

# Usually you set "language" from the command line for these cases.

language = None

# 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 = ['_build', 'Thumbs.db', '.DS_Store']

# 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'

# 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 = []

# -- Options for HTMLHelp output ------------------------------------------

# Output file base name for HTML help builder.

htmlhelp_basename = 'python-sdc-clientdoc'

# -- Options for LaTeX output ---------------------------------------------

latex_elements = {

# The paper size ('letterpaper' or 'a4paper').

# 'papersize': 'letterpaper',

# The font size ('10pt', '11pt' or '12pt').

# 'pointsize': '10pt',

# Additional stuff for the LaTeX preamble.

# 'preamble': '',

# Latex figure (float) alignment

# 'figure_align': 'htbp',

}

# 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, 'python-sdc-client.tex', u'python-sdc-client Documentation',

u'Sysdig Inc.', '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, 'python-sdc-client', u'python-sdc-client Documentation',

[author], 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, 'python-sdc-client', u'python-sdc-client Documentation',

author, 'python-sdc-client', 'One line description of project.',

'Miscellaneous'),

]

# Napoleon settings

napoleon_google_docstring = True

napoleon_include_init_with_doc = False

napoleon_include_private_with_doc = True

napoleon_include_special_with_doc = True

napoleon_use_admonition_for_examples = False

napoleon_use_admonition_for_notes = False

napoleon_use_admonition_for_references = False

napoleon_use_ivar = False

napoleon_use_param = True

napoleon_use_rtype = True

napoleon_type_aliases = None

sysdig-sdk-python/docs/conf.py at master · sysdiglabs/sysdig-sdk-python · GitHub

Expand file tree

Breadcrumbs

conf.py

Latest commit

History

Breadcrumbs

conf.py

File metadata and controls