Debian Codegraph @

docs/source/conf.py

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