conf.py 8.54 KB
 legac committed Apr 11, 2015 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.  LE GAC Renaud committed Apr 15, 2015 13 import os  legac committed Apr 19, 2015 14 15 import re import sys  LE GAC Renaud committed Apr 15, 2015 16 17  from datetime import datetime  LE GAC Renaud committed Dec 03, 2019 18 from pathlib import Path  legac committed Apr 11, 2015 19   legac committed Apr 19, 2015 20   LE GAC Renaud committed Dec 03, 2019 21 22 23 def get_version(): return Path("../../../VERSION").read_text()  legac committed Apr 19, 2015 24   legac committed Apr 11, 2015 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 committed May 09, 2017 28 # sys.path.insert(0, os.path.abspath("."))  LE GAC Renaud committed Dec 03, 2019 29 sys.path.insert(0, os.path.abspath("../../../modules"))  LE GAC Renaud committed Feb 25, 2016 30   LE GAC Renaud committed Dec 03, 2019 31 # web2py module from the my docker image running sphinx-build  LE GAC Renaud committed Feb 25, 2016 32 if os.path.exists("/opt/web2py"):  LE GAC Renaud committed May 09, 2017 33  sys.path.insert(0, os.path.abspath("/opt/web2py"))  LE GAC Renaud committed Feb 25, 2016 34 35  else:  LE GAC Renaud committed Dec 03, 2019 36 37  print("error: missing source code for web2py!!!") sys.exit(1)  legac committed Apr 11, 2015 38 39 40 41  # -- General configuration ----------------------------------------------------- # If your documentation needs a minimal Sphinx version, state it here.  LE GAC Renaud committed May 09, 2017 42 # needs_sphinx = "1.0"  legac committed Apr 11, 2015 43 44  # Add any Sphinx extension module names here, as strings. They can be extensions  LE GAC Renaud committed May 09, 2017 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"]  legac committed Apr 11, 2015 53   LE GAC Renaud committed Apr 15, 2015 54 # autosummary configuration  LE GAC Renaud committed Dec 03, 2019 55 autosummary_generate = True  LE GAC Renaud committed Apr 15, 2015 56 57  # intersphinx configuration  LE GAC Renaud committed Dec 03, 2019 58 intersphinx_mapping = {"python": ("http://docs.python.org/3.7", None)}  LE GAC Renaud committed Apr 15, 2015 59 60 61 62  # napoleon configuration napoleon_user_rtype = False  legac committed Apr 11, 2015 63 # Add any paths that contain templates here, relative to this directory.  LE GAC Renaud committed May 09, 2017 64 templates_path = ["_templates"]  legac committed Apr 11, 2015 65 66  # The suffix of source filenames.  LE GAC Renaud committed May 09, 2017 67 source_suffix = ".rst"  legac committed Apr 11, 2015 68 69  # The encoding of source files.  LE GAC Renaud committed May 09, 2017 70 # source_encoding = "utf-8-sig"  legac committed Apr 11, 2015 71 72  # The master toctree document.  LE GAC Renaud committed May 09, 2017 73 master_doc = "index"  legac committed Apr 11, 2015 74 75  # General information about the project.  legac committed Apr 19, 2015 76 now = datetime.now()  LE GAC Renaud committed Dec 03, 2019 77 78 project = "plugin_dbui" copyright = "2009-%s, R. Le Gac, licensed under CeCILL" % now.year  legac committed Apr 11, 2015 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 committed Dec 03, 2019 85 release = get_version()  legac committed Apr 19, 2015 86 87  # The short X.Y version.  LE GAC Renaud committed May 09, 2017 88 version = release[:release.rfind(".")]  legac committed Apr 11, 2015 89 90 91  # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages.  LE GAC Renaud committed Apr 15, 2015 92 # language = None  legac committed Apr 11, 2015 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 committed May 09, 2017 96 # today = ""  legac committed Apr 11, 2015 97 # Else, today_fmt is used as the format for a strftime call.  LE GAC Renaud committed May 09, 2017 98 # today_fmt = "%B %d, %Y"  legac committed Apr 11, 2015 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 committed May 09, 2017 102 exclude_patterns = ["_build"]  legac committed Apr 11, 2015 103 104  # The reST default role (used for this markup: text) to use for all documents.  LE GAC Renaud committed Apr 15, 2015 105 # default_role = None  legac committed Apr 11, 2015 106   LE GAC Renaud committed May 09, 2017 107 # If true, "()" will be appended to :func: etc. cross-reference text.  LE GAC Renaud committed Apr 15, 2015 108 # add_function_parentheses = True  legac committed Apr 11, 2015 109 110 111  # If true, the current module name will be prepended to all description # unit titles (such as .. function::).  LE GAC Renaud committed Apr 15, 2015 112 # add_module_names = True  legac committed Apr 11, 2015 113 114 115  # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default.  LE GAC Renaud committed Apr 15, 2015 116 # show_authors = False  legac committed Apr 11, 2015 117 118  # The name of the Pygments (syntax highlighting) style to use.  LE GAC Renaud committed May 09, 2017 119 pygments_style = "sphinx"  legac committed Apr 11, 2015 120 121  # A list of ignored prefixes for module index sorting.  LE GAC Renaud committed Apr 15, 2015 122 # modindex_common_prefix = []  legac committed Apr 11, 2015 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 committed May 09, 2017 129 html_theme = "sphinxdoc"  legac committed Apr 11, 2015 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.  LE GAC Renaud committed Apr 15, 2015 134 # html_theme_options = {}  legac committed Apr 11, 2015 135 136  # Add any paths that contain custom themes here, relative to this directory.  LE GAC Renaud committed Apr 15, 2015 137 # html_theme_path = []  legac committed Apr 11, 2015 138 139 140  # The name for this set of Sphinx documents. If None, it defaults to # " v documentation".  LE GAC Renaud committed Apr 15, 2015 141 # html_title = None  legac committed Apr 11, 2015 142 143  # A shorter title for the navigation bar. Default is the same as html_title.  LE GAC Renaud committed Apr 15, 2015 144 # html_short_title = None  legac committed Apr 11, 2015 145 146 147  # The name of an image file (relative to this directory) to place at the top # of the sidebar.  LE GAC Renaud committed Apr 15, 2015 148 # html_logo = None  legac committed Apr 11, 2015 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.  LE GAC Renaud committed Apr 15, 2015 153 # html_favicon = None  legac committed Apr 11, 2015 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 committed May 09, 2017 158 # html_static_path = ["_static"]  legac committed Apr 11, 2015 159   LE GAC Renaud committed May 09, 2017 160 # If not "", a "Last updated on:" timestamp is inserted at every page bottom,  legac committed Apr 11, 2015 161 # using the given strftime format.  LE GAC Renaud committed May 09, 2017 162 # html_last_updated_fmt = "%b %d, %Y"  legac committed Apr 11, 2015 163 164 165  # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities.  LE GAC Renaud committed Apr 15, 2015 166 # html_use_smartypants = True  legac committed Apr 11, 2015 167 168  # Custom sidebar templates, maps document names to template names.  LE GAC Renaud committed Apr 15, 2015 169 # html_sidebars = {}  legac committed Apr 11, 2015 170 171 172  # Additional templates that should be rendered to pages, maps page names to # template names.  LE GAC Renaud committed Apr 15, 2015 173 # html_additional_pages = {}  legac committed Apr 11, 2015 174 175  # If false, no module index is generated.  LE GAC Renaud committed Apr 15, 2015 176 # html_domain_indices = True  legac committed Apr 11, 2015 177 178  # If false, no index is generated.  LE GAC Renaud committed Apr 15, 2015 179 # html_use_index = True  legac committed Apr 11, 2015 180 181  # If true, the index is split into individual pages for each letter.  LE GAC Renaud committed Apr 15, 2015 182 # html_split_index = False  legac committed Apr 11, 2015 183 184  # If true, links to the reST sources are added to the pages.  LE GAC Renaud committed Apr 15, 2015 185 # html_show_sourcelink = True  legac committed Apr 11, 2015 186 187  # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.  LE GAC Renaud committed Apr 15, 2015 188 # html_show_sphinx = True  legac committed Apr 11, 2015 189 190  # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.  LE GAC Renaud committed Apr 15, 2015 191 # html_show_copyright = True  legac committed Apr 11, 2015 192 193 194 195  # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # base URL from which the finished HTML is served.  LE GAC Renaud committed May 09, 2017 196 # html_use_opensearch = ""  legac committed Apr 11, 2015 197 198  # This is the file name suffix for HTML files (e.g. ".xhtml").  LE GAC Renaud committed Apr 15, 2015 199 # html_file_suffix = None  legac committed Apr 11, 2015 200 201  # Output file base name for HTML help builder.  LE GAC Renaud committed May 09, 2017 202 htmlhelp_basename = "plugin_dbuidoc"  legac committed Apr 11, 2015 203 204 205 206 207  # -- Options for LaTeX output -------------------------------------------------- latex_elements = {  LE GAC Renaud committed May 09, 2017 208 209 # The paper size ("letterpaper" or "a4paper"). # "papersize": "letterpaper",  legac committed Apr 11, 2015 210   LE GAC Renaud committed May 09, 2017 211 212 # The font size ("10pt", "11pt" or "12pt"). # "pointsize": "10pt",  legac committed Apr 11, 2015 213 214  # Additional stuff for the LaTeX preamble.  LE GAC Renaud committed May 09, 2017 215 # "preamble": "",  legac committed Apr 11, 2015 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 committed Dec 05, 2019 221  ("index", "plugin_dbui_api.tex", r"plugin\_dbui API Guide",  LE GAC Renaud committed Dec 03, 2019 222  "R. Le Gac", "manual"),  legac committed Apr 11, 2015 223 224 225 226 ] # The name of an image file (relative to this directory) to place at the top of # the title page.  LE GAC Renaud committed Apr 15, 2015 227 # latex_logo = None  legac committed Apr 11, 2015 228 229 230  # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters.  LE GAC Renaud committed Apr 15, 2015 231 # latex_use_parts = False  legac committed Apr 11, 2015 232 233  # If true, show page references after internal links.  LE GAC Renaud committed Apr 15, 2015 234 # latex_show_pagerefs = False  legac committed Apr 11, 2015 235 236  # If true, show URL addresses after external links.  LE GAC Renaud committed Apr 15, 2015 237 # latex_show_urls = False  legac committed Apr 11, 2015 238 239  # Documents to append as an appendix to all manuals.  LE GAC Renaud committed Apr 15, 2015 240 # latex_appendices = []  legac committed Apr 11, 2015 241 242  # If false, no module index is generated.  LE GAC Renaud committed Apr 15, 2015 243 # latex_domain_indices = True  legac committed Apr 11, 2015 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 = [  LE GAC Renaud committed Dec 05, 2019 251  ("index", "plugin_dbui_api", "plugin_dbui Documentation",  LE GAC Renaud committed Dec 03, 2019 252  ["R. Le Gac"], 1)  legac committed Apr 11, 2015 253 254 255 ] # If true, show URL addresses after external links.  LE GAC Renaud committed Apr 15, 2015 256 # man_show_urls = False  legac committed Apr 11, 2015 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 = [  LE GAC Renaud committed Dec 05, 2019 265  ("index", "plugin_dbui_api", "plugin_dbui Documentation",  LE GAC Renaud committed Dec 03, 2019 266  "R. Le Gac", "plugin_dbui", "One line description of project.",  LE GAC Renaud committed May 09, 2017 267  "Miscellaneous"),  legac committed Apr 11, 2015 268 269 270 ] # Documents to append as an appendix to all manuals.  LE GAC Renaud committed Apr 15, 2015 271 # texinfo_appendices = []  legac committed Apr 11, 2015 272 273  # If false, no module index is generated.  LE GAC Renaud committed Apr 15, 2015 274 # texinfo_domain_indices = True  legac committed Apr 11, 2015 275   LE GAC Renaud committed May 09, 2017 276 277 # How to display URL addresses: "footnote", "no", or "inline". # texinfo_show_urls = "footnote"