docs/conf.py

   1 # -*- coding: utf-8 -*-
   2 #
   3 # Configuration file for the Sphinx documentation builder.
   4 #
   5 # This file does only contain a selection of the most common options. For a
   6 # full list see the documentation:
   7 # http://www.sphinx-doc.org/en/master/config
   8
   9 # -- Path setup --------------------------------------------------------------
  10
  11 # If extensions (or modules to document with autodoc) are in another directory,
  12 # add these directories to sys.path here. If the directory is relative to the
  13 # documentation root, use os.path.abspath to make it absolute, like shown here.
  14 #
  15 # import os
  16 # import sys
  17 # sys.path.insert(0, os.path.abspath('.'))
  18
  19
  20 # -- Project information -----------------------------------------------------
  21
  22 project = 'Otter'
  23 copyright = '2021 Ian Jackson and the contributors to Otter'
  24 author = 'Ian Jackson et al'
  25
  26 # The short X.Y version
  27 version = ''
  28 # The full version, including alpha/beta/rc tags
  29 release = ''
  30
  31
  32 # -- General configuration ---------------------------------------------------
  33
  34 # If your documentation needs a minimal Sphinx version, state it here.
  35 #
  36 # needs_sphinx = '1.0'
  37
  38 # Add any Sphinx extension module names here, as strings. They can be
  39 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  40 # ones.
  41 extensions = [
  42     'recommonmark',
  43 ]
  44
  45 # Add any paths that contain templates here, relative to this directory.
  46 templates_path = ['_templates']
  47
  48 # The suffix(es) of source filenames.
  49 # You can specify multiple suffix as a list of string:
  50 #
  51 #source_suffix = ['.rst', '.md']
  52 #source_suffix = '.rst'
  53
  54 # https://github.com/readthedocs/recommonmark (retrieved 8.4.2021)
  55 from recommonmark.parser import CommonMarkParser
  56 source_parsers = {
  57     '.md': CommonMarkParser,
  58 }
  59 source_suffix = {
  60    '.rst': 'restructuredtext',
  61    '.txt': 'markdown',
  62    '.md': 'markdown',
  63 }
  64
  65 # The master toctree document.
  66 master_doc = 'index'
  67
  68 # The language for content autogenerated by Sphinx. Refer to documentation
  69 # for a list of supported languages.
  70 #
  71 # This is also used if you do content translation via gettext catalogs.
  72 # Usually you set "language" from the command line for these cases.
  73 language = None
  74
  75 # List of patterns, relative to source directory, that match files and
  76 # directories to ignore when looking for source files.
  77 # This pattern also affects html_static_path and html_extra_path.
  78 exclude_patterns = []
  79
  80 # The name of the Pygments (syntax highlighting) style to use.
  81 pygments_style = None
  82
  83
  84 # -- Options for HTML output -------------------------------------------------
  85
  86 # The theme to use for HTML and HTML Help pages.  See the documentation for
  87 # a list of builtin themes.
  88 #
  89 html_theme = 'classic'
  90
  91 # Theme options are theme-specific and customize the look and feel of a theme
  92 # further.  For a list of options available for each theme, see the
  93 # documentation.
  94 #
  95 # html_theme_options = {}
  96
  97 # Add any paths that contain custom static files (such as style sheets) here,
  98 # relative to this directory. They are copied after the builtin static files,
  99 # so a file named "default.css" will overwrite the builtin "default.css".
 100 html_static_path = ['_static']
 101
 102 # Custom sidebar templates, must be a dictionary that maps document names
 103 # to template names.
 104 #
 105 # The default sidebars (for documents that don't match any pattern) are
 106 # defined by theme itself.  Builtin themes are using these templates by
 107 # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
 108 # 'searchbox.html']``.
 109 #
 110 # html_sidebars = {}
 111
 112
 113 # -- Options for HTMLHelp output ---------------------------------------------
 114
 115 # Output file base name for HTML help builder.
 116 htmlhelp_basename = 'Otterdoc'
 117
 118
 119 # -- Options for LaTeX output ------------------------------------------------
 120
 121 latex_elements = {
 122     # The paper size ('letterpaper' or 'a4paper').
 123     #
 124     # 'papersize': 'letterpaper',
 125
 126     # The font size ('10pt', '11pt' or '12pt').
 127     #
 128     # 'pointsize': '10pt',
 129
 130     # Additional stuff for the LaTeX preamble.
 131     #
 132     # 'preamble': '',
 133
 134     # Latex figure (float) alignment
 135     #
 136     # 'figure_align': 'htbp',
 137 }
 138
 139 # Grouping the document tree into LaTeX files. List of tuples
 140 # (source start file, target name, title,
 141 #  author, documentclass [howto, manual, or own class]).
 142 latex_documents = [
 143     (master_doc, 'Otter.tex', 'Otter Documentation',
 144      'Ian Jackson and the contributors to Otter', 'manual'),
 145 ]
 146
 147
 148 # -- Options for manual page output ------------------------------------------
 149
 150 # One entry per manual page. List of tuples
 151 # (source start file, name, description, authors, manual section).
 152 man_pages = [
 153     (master_doc, 'otter', 'Otter Documentation',
 154      [author], 1)
 155 ]
 156
 157
 158 # -- Options for Texinfo output ----------------------------------------------
 159
 160 # Grouping the document tree into Texinfo files. List of tuples
 161 # (source start file, target name, title, author,
 162 #  dir menu entry, description, category)
 163 texinfo_documents = [
 164     (master_doc, 'Otter', 'Otter Documentation',
 165      author, 'Otter', 'Online Table Top Environment Renderer',
 166      'Games'),
 167 ]
 168
 169
 170 # -- Options for Epub output -------------------------------------------------
 171
 172 # Bibliographic Dublin Core info.
 173 epub_title = project
 174
 175 # The unique identifier of the text. This can be a ISBN number
 176 # or the project homepage.
 177 #
 178 # epub_identifier = ''
 179
 180 # A unique identification for the text.
 181 #
 182 # epub_uid = ''
 183
 184 # A list of files that should not be packed into the epub file.
 185 epub_exclude_files = ['search.html']