doc/conf.py

   1 # SPDX-License-Identifier: BSD-3-Clause
   2 # Copyright 2019 Olivier Matz <zer0@droids-corp.org>
   3
   4 # -*- coding: utf-8 -*-
   5 #
   6 # Libecoli Documentation documentation build configuration file, created by
   7 # sphinx-quickstart on Thu May 23 20:10:46 2019.
   8 #
   9 # This file is execfile()d with the current directory set to its
  10 # containing dir.
  11 #
  12 # Note that not all possible configuration values are present in this
  13 # autogenerated file.
  14 #
  15 # All configuration values have a default; values that are commented out
  16 # serve to show the default.
  17
  18 # If extensions (or modules to document with autodoc) are in another directory,
  19 # add these directories to sys.path here. If the directory is relative to the
  20 # documentation root, use os.path.abspath to make it absolute, like shown here.
  21 #
  22 # import os
  23 # import sys
  24 # sys.path.insert(0, os.path.abspath('.'))
  25
  26
  27 # -- General configuration ------------------------------------------------
  28
  29 # If your documentation needs a minimal Sphinx version, state it here.
  30 #
  31 # needs_sphinx = '1.0'
  32
  33 # Add any Sphinx extension module names here, as strings. They can be
  34 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  35 # ones.
  36 extensions = ['breathe']
  37 import os
  38 cautodoc_root = os.path.abspath('my/sources/dir')
  39
  40 # Add any paths that contain templates here, relative to this directory.
  41 templates_path = ['_templates']
  42
  43 # The suffix(es) of source filenames.
  44 # You can specify multiple suffix as a list of string:
  45 #
  46 # source_suffix = ['.rst', '.md']
  47 source_suffix = '.rst'
  48
  49 # The master toctree document.
  50 master_doc = 'index'
  51
  52 # General information about the project.
  53 project = u'Libecoli Documentation'
  54 copyright = u'2019, Olivier Matz'
  55 author = u'Olivier Matz'
  56
  57 # The version info for the project you're documenting, acts as replacement for
  58 # |version| and |release|, also used in various other places throughout the
  59 # built documents.
  60 #
  61 # The short X.Y version.
  62 version = u'0.1'
  63 # The full version, including alpha/beta/rc tags.
  64 release = u'0.1'
  65
  66 # The language for content autogenerated by Sphinx. Refer to documentation
  67 # for a list of supported languages.
  68 #
  69 # This is also used if you do content translation via gettext catalogs.
  70 # Usually you set "language" from the command line for these cases.
  71 language = None
  72
  73 # List of patterns, relative to source directory, that match files and
  74 # directories to ignore when looking for source files.
  75 # This patterns also effect to html_static_path and html_extra_path
  76 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
  77
  78 # The name of the Pygments (syntax highlighting) style to use.
  79 pygments_style = 'sphinx'
  80
  81 # If true, `todo` and `todoList` produce output, else they produce nothing.
  82 todo_include_todos = False
  83
  84
  85 # -- Options for HTML output ----------------------------------------------
  86
  87 # The theme to use for HTML and HTML Help pages.  See the documentation for
  88 # a list of builtin themes.
  89 #
  90 html_theme = 'alabaster'
  91
  92 # Theme options are theme-specific and customize the look and feel of a theme
  93 # further.  For a list of options available for each theme, see the
  94 # documentation.
  95 #
  96 html_theme_options = {
  97     'sidebar_width': '350px',
  98     'logo': 'libecoli.svg',
  99     'fixed_sidebar': True,
 100     'page_width': '1200px',
 101 }
 102
 103 # Add any paths that contain custom static files (such as style sheets) here,
 104 # relative to this directory. They are copied after the builtin static files,
 105 # so a file named "default.css" will overwrite the builtin "default.css".
 106 html_static_path = ['_static']
 107
 108 # Custom sidebar templates, must be a dictionary that maps document names
 109 # to template names.
 110 #
 111 # This is required for the alabaster theme
 112 # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
 113 html_sidebars = {
 114     '**': [
 115         'about.html',
 116         'navigation.html',
 117         'relations.html',  # needs 'show_related': True theme option to display
 118         'searchbox.html',
 119         'donate.html',
 120     ]
 121 }
 122
 123
 124 # -- Options for HTMLHelp output ------------------------------------------
 125
 126 # Output file base name for HTML help builder.
 127 htmlhelp_basename = 'LibecoliDocumentationdoc'
 128
 129
 130 # -- Options for LaTeX output ---------------------------------------------
 131
 132 latex_elements = {
 133     # The paper size ('letterpaper' or 'a4paper').
 134     #
 135     # 'papersize': 'letterpaper',
 136
 137     # The font size ('10pt', '11pt' or '12pt').
 138     #
 139     # 'pointsize': '10pt',
 140
 141     # Additional stuff for the LaTeX preamble.
 142     #
 143     # 'preamble': '',
 144
 145     # Latex figure (float) alignment
 146     #
 147     # 'figure_align': 'htbp',
 148 }
 149
 150 # Grouping the document tree into LaTeX files. List of tuples
 151 # (source start file, target name, title,
 152 #  author, documentclass [howto, manual, or own class]).
 153 latex_documents = [
 154     (master_doc, 'LibecoliDocumentation.tex', u'Libecoli Documentation Documentation',
 155      u'Olivier Matz', 'manual'),
 156 ]
 157
 158
 159 # -- Options for manual page output ---------------------------------------
 160
 161 # One entry per manual page. List of tuples
 162 # (source start file, name, description, authors, manual section).
 163 man_pages = [
 164     (master_doc, 'libecolidocumentation', u'Libecoli Documentation Documentation',
 165      [author], 1)
 166 ]
 167
 168
 169 # -- Options for Texinfo output -------------------------------------------
 170
 171 # Grouping the document tree into Texinfo files. List of tuples
 172 # (source start file, target name, title, author,
 173 #  dir menu entry, description, category)
 174 texinfo_documents = [
 175     (master_doc, 'LibecoliDocumentation', u'Libecoli Documentation Documentation',
 176      author, 'LibecoliDocumentation', 'One line description of project.',
 177      'Miscellaneous'),
 178 ]