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