Docker-in-Docker (DinD) capabilities of public runners deactivated. More info

conf.py 8.54 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12
#
# plugin_dbui documentation build configuration file, created by
# sphinx-quickstart on Sat Apr 11 11:17:03 2015.
#
# 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.

13
import os
legac's avatar
legac committed
14 15
import re
import sys
16 17

from datetime import datetime
LE GAC Renaud's avatar
LE GAC Renaud committed
18
from pathlib import Path
19

legac's avatar
legac committed
20

LE GAC Renaud's avatar
LE GAC Renaud committed
21 22 23
def get_version():
    return Path("../../../VERSION").read_text()

legac's avatar
legac committed
24

25 26 27
# 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.
LE GAC Renaud's avatar
LE GAC Renaud committed
28
# sys.path.insert(0, os.path.abspath("."))
LE GAC Renaud's avatar
LE GAC Renaud committed
29
sys.path.insert(0, os.path.abspath("../../../modules"))
30

LE GAC Renaud's avatar
LE GAC Renaud committed
31
# web2py module from the my docker image running sphinx-build
32
if os.path.exists("/opt/web2py"):
LE GAC Renaud's avatar
LE GAC Renaud committed
33
    sys.path.insert(0, os.path.abspath("/opt/web2py"))
34 35

else:
LE GAC Renaud's avatar
LE GAC Renaud committed
36 37
    print("error: missing source code for web2py!!!")
    sys.exit(1)
38 39 40 41

# -- General configuration -----------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
LE GAC Renaud's avatar
LE GAC Renaud committed
42
# needs_sphinx = "1.0"
43 44

# Add any Sphinx extension module names here, as strings. They can be extensions
LE GAC Renaud's avatar
LE GAC Renaud committed
45 46 47 48 49 50 51 52
# coming with Sphinx (named "sphinx.ext.*") or your custom ones.
extensions = ["sphinx.ext.autodoc",
              "sphinx.ext.autosummary",
              "sphinx.ext.intersphinx",
              "sphinx.ext.napoleon",
              "sphinx.ext.todo",
              "sphinx.ext.mathjax",
              "sphinx.ext.viewcode"]
53

54
# autosummary configuration
LE GAC Renaud's avatar
LE GAC Renaud committed
55
autosummary_generate = True
56 57

# intersphinx configuration
LE GAC Renaud's avatar
LE GAC Renaud committed
58
intersphinx_mapping = {"python": ("http://docs.python.org/3.7", None)}
59 60 61 62

# napoleon configuration
napoleon_user_rtype = False

63
# Add any paths that contain templates here, relative to this directory.
LE GAC Renaud's avatar
LE GAC Renaud committed
64
templates_path = ["_templates"]
65 66

# The suffix of source filenames.
LE GAC Renaud's avatar
LE GAC Renaud committed
67
source_suffix = ".rst"
68 69

# The encoding of source files.
LE GAC Renaud's avatar
LE GAC Renaud committed
70
# source_encoding = "utf-8-sig"
71 72

# The master toctree document.
LE GAC Renaud's avatar
LE GAC Renaud committed
73
master_doc = "index"
74 75

# General information about the project.
legac's avatar
legac committed
76
now = datetime.now()
LE GAC Renaud's avatar
LE GAC Renaud committed
77 78
project = "plugin_dbui"
copyright = "2009-%s, R. Le Gac, licensed under CeCILL" % now.year
79 80 81 82 83 84

# 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 full version, including alpha/beta/rc tags.
LE GAC Renaud's avatar
LE GAC Renaud committed
85
release = get_version()
legac's avatar
legac committed
86 87

# The short X.Y version.
LE GAC Renaud's avatar
LE GAC Renaud committed
88
version = release[:release.rfind(".")]
89 90 91

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
92
# language = None
93 94 95

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
LE GAC Renaud's avatar
LE GAC Renaud committed
96
# today = ""
97
# Else, today_fmt is used as the format for a strftime call.
LE GAC Renaud's avatar
LE GAC Renaud committed
98
# today_fmt = "%B %d, %Y"
99 100 101

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
LE GAC Renaud's avatar
LE GAC Renaud committed
102
exclude_patterns = ["_build"]
103 104

# The reST default role (used for this markup: `text`) to use for all documents.
105
# default_role = None
106

LE GAC Renaud's avatar
LE GAC Renaud committed
107
# If true, "()" will be appended to :func: etc. cross-reference text.
108
# add_function_parentheses = True
109 110 111

# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
112
# add_module_names = True
113 114 115

# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
116
# show_authors = False
117 118

# The name of the Pygments (syntax highlighting) style to use.
LE GAC Renaud's avatar
LE GAC Renaud committed
119
pygments_style = "sphinx"
120 121

# A list of ignored prefixes for module index sorting.
122
# modindex_common_prefix = []
123 124 125 126 127 128


# -- Options for HTML output ---------------------------------------------------

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
LE GAC Renaud's avatar
LE GAC Renaud committed
129
html_theme = "sphinxdoc"
130 131 132 133

# 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.
134
# html_theme_options = {}
135 136

# Add any paths that contain custom themes here, relative to this directory.
137
# html_theme_path = []
138 139 140

# The name for this set of Sphinx documents.  If None, it defaults to
# "<project> v<release> documentation".
141
# html_title = None
142 143

# A shorter title for the navigation bar.  Default is the same as html_title.
144
# html_short_title = None
145 146 147

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
148
# html_logo = None
149 150 151 152

# The name of an image file (within the static path) to use as favicon of the
# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
153
# html_favicon = None
154 155 156 157

# 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".
LE GAC Renaud's avatar
LE GAC Renaud committed
158
# html_static_path = ["_static"]
159

LE GAC Renaud's avatar
LE GAC Renaud committed
160
# If not "", a "Last updated on:" timestamp is inserted at every page bottom,
161
# using the given strftime format.
LE GAC Renaud's avatar
LE GAC Renaud committed
162
# html_last_updated_fmt = "%b %d, %Y"
163 164 165

# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
166
# html_use_smartypants = True
167 168

# Custom sidebar templates, maps document names to template names.
169
# html_sidebars = {}
170 171 172

# Additional templates that should be rendered to pages, maps page names to
# template names.
173
# html_additional_pages = {}
174 175

# If false, no module index is generated.
176
# html_domain_indices = True
177 178

# If false, no index is generated.
179
# html_use_index = True
180 181

# If true, the index is split into individual pages for each letter.
182
# html_split_index = False
183 184

# If true, links to the reST sources are added to the pages.
185
# html_show_sourcelink = True
186 187

# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
188
# html_show_sphinx = True
189 190

# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
191
# html_show_copyright = True
192 193 194 195

# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it.  The value of this option must be the
# base URL from which the finished HTML is served.
LE GAC Renaud's avatar
LE GAC Renaud committed
196
# html_use_opensearch = ""
197 198

# This is the file name suffix for HTML files (e.g. ".xhtml").
199
# html_file_suffix = None
200 201

# Output file base name for HTML help builder.
LE GAC Renaud's avatar
LE GAC Renaud committed
202
htmlhelp_basename = "plugin_dbuidoc"
203 204 205 206 207


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

latex_elements = {
LE GAC Renaud's avatar
LE GAC Renaud committed
208 209
# The paper size ("letterpaper" or "a4paper").
# "papersize": "letterpaper",
210

LE GAC Renaud's avatar
LE GAC Renaud committed
211 212
# The font size ("10pt", "11pt" or "12pt").
# "pointsize": "10pt",
213 214

# Additional stuff for the LaTeX preamble.
LE GAC Renaud's avatar
LE GAC Renaud committed
215
# "preamble": "",
216 217 218 219 220
}

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
LE GAC Renaud's avatar
LE GAC Renaud committed
221
  ("index", "plugin_dbui_api.tex", r"plugin\_dbui API Guide",
LE GAC Renaud's avatar
LE GAC Renaud committed
222
   "R. Le Gac", "manual"),
223 224 225 226
]

# The name of an image file (relative to this directory) to place at the top of
# the title page.
227
# latex_logo = None
228 229 230

# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
231
# latex_use_parts = False
232 233

# If true, show page references after internal links.
234
# latex_show_pagerefs = False
235 236

# If true, show URL addresses after external links.
237
# latex_show_urls = False
238 239

# Documents to append as an appendix to all manuals.
240
# latex_appendices = []
241 242

# If false, no module index is generated.
243
# latex_domain_indices = True
244 245 246 247 248 249 250


# -- Options for manual page output --------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
251
    ("index", "plugin_dbui_api", "plugin_dbui Documentation",
LE GAC Renaud's avatar
LE GAC Renaud committed
252
     ["R. Le Gac"], 1)
253 254 255
]

# If true, show URL addresses after external links.
256
# man_show_urls = False
257 258 259 260 261 262 263 264


# -- 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 = [
265
  ("index", "plugin_dbui_api", "plugin_dbui Documentation",
LE GAC Renaud's avatar
LE GAC Renaud committed
266
   "R. Le Gac", "plugin_dbui", "One line description of project.",
LE GAC Renaud's avatar
LE GAC Renaud committed
267
   "Miscellaneous"),
268 269 270
]

# Documents to append as an appendix to all manuals.
271
# texinfo_appendices = []
272 273

# If false, no module index is generated.
274
# texinfo_domain_indices = True
275

LE GAC Renaud's avatar
LE GAC Renaud committed
276 277
# How to display URL addresses: "footnote", "no", or "inline".
# texinfo_show_urls = "footnote"