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 = 'Hippotat'
  23 copyright = '2021 Ian Jackson and the contributors to Hippotat'
  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     'sphinx.ext.autosectionlabel',
  44     'sphinx_markdown_tables',
  45 ]
  46 autosectionlabel_prefix_document = True
  47
  48 # Add any paths that contain templates here, relative to this directory.
  49 templates_path = ['_templates']
  50
  51 # The suffix(es) of source filenames.
  52 # You can specify multiple suffix as a list of string:
  53 #
  54 #source_suffix = ['.rst', '.md']
  55 #source_suffix = '.rst'
  56
  57 # https://github.com/readthedocs/recommonmark (retrieved 8.4.2021)
  58 from recommonmark.parser import CommonMarkParser
  59 source_parsers = {
  60     '.md': CommonMarkParser,
  61 }
  62 source_suffix = {
  63    '.rst': 'restructuredtext',
  64    '.txt': 'markdown',
  65    '.md': 'markdown',
  66 }
  67
  68 # The master toctree document.
  69 master_doc = 'index'
  70
  71 # The language for content autogenerated by Sphinx. Refer to documentation
  72 # for a list of supported languages.
  73 #
  74 # This is also used if you do content translation via gettext catalogs.
  75 # Usually you set "language" from the command line for these cases.
  76 language = None
  77
  78 # List of patterns, relative to source directory, that match files and
  79 # directories to ignore when looking for source files.
  80 # This pattern also affects html_static_path and html_extra_path.
  81 exclude_patterns = []
  82
  83 # The name of the Pygments (syntax highlighting) style to use.
  84 pygments_style = None
  85
  86
  87 # -- Options for HTML output -------------------------------------------------
  88
  89 # The theme to use for HTML and HTML Help pages.  See the documentation for
  90 # a list of builtin themes.
  91 #
  92 html_theme = 'classic'
  93
  94 # Theme options are theme-specific and customize the look and feel of a theme
  95 # further.  For a list of options available for each theme, see the
  96 # documentation.
  97 #
  98 # html_theme_options = {}
  99
 100 # Add any paths that contain custom static files (such as style sheets) here,
 101 # relative to this directory. They are copied after the builtin static files,
 102 # so a file named "default.css" will overwrite the builtin "default.css".
 103 html_static_path = ['_static']
 104
 105 # Custom sidebar templates, must be a dictionary that maps document names
 106 # to template names.
 107 #
 108 # The default sidebars (for documents that don't match any pattern) are
 109 # defined by theme itself.  Builtin themes are using these templates by
 110 # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
 111 # 'searchbox.html']``.
 112 #
 113 # html_sidebars = {}
 114
 115
 116 # -- Options for HTMLHelp output ---------------------------------------------
 117
 118 # Output file base name for HTML help builder.
 119 htmlhelp_basename = 'Hippotatdoc'
 120
 121
 122 # -- Options for LaTeX output ------------------------------------------------
 123
 124 latex_elements = {
 125     # The paper size ('letterpaper' or 'a4paper').
 126     #
 127     # 'papersize': 'letterpaper',
 128
 129     # The font size ('10pt', '11pt' or '12pt').
 130     #
 131     # 'pointsize': '10pt',
 132
 133     # Additional stuff for the LaTeX preamble.
 134     #
 135     # 'preamble': '',
 136
 137     # Latex figure (float) alignment
 138     #
 139     # 'figure_align': 'htbp',
 140 }
 141
 142 # Grouping the document tree into LaTeX files. List of tuples
 143 # (source start file, target name, title,
 144 #  author, documentclass [howto, manual, or own class]).
 145 latex_documents = [
 146     (master_doc, 'Hippotat.tex', 'Hippotat Documentation',
 147      'Ian Jackson and the contributors to Hippotat', 'manual'),
 148 ]
 149
 150
 151 # -- Options for manual page output ------------------------------------------
 152
 153 # One entry per manual page. List of tuples
 154 # (source start file, name, description, authors, manual section).
 155 man_pages = [
 156     (master_doc, 'otter', 'Hippotat Documentation',
 157      [author], 1)
 158 ]
 159
 160
 161 # -- Options for Texinfo output ----------------------------------------------
 162
 163 # Grouping the document tree into Texinfo files. List of tuples
 164 # (source start file, target name, title, author,
 165 #  dir menu entry, description, category)
 166 texinfo_documents = [
 167     (master_doc, 'Hippotat', 'Hippotat Documentation',
 168      author, 'Hippotat', 'Online Table Top Environment Renderer',
 169      'Games'),
 170 ]
 171
 172
 173 # -- Options for Epub output -------------------------------------------------
 174
 175 # Bibliographic Dublin Core info.
 176 epub_title = project
 177
 178 # The unique identifier of the text. This can be a ISBN number
 179 # or the project homepage.
 180 #
 181 # epub_identifier = ''
 182
 183 # A unique identification for the text.
 184 #
 185 # epub_uid = ''
 186
 187 # A list of files that should not be packed into the epub file.
 188 epub_exclude_files = ['search.html']