Mercurial > repos > guerler > springsuite

comparison planemo/lib/python3.7/site-packages/importlib_metadata/docs/conf.py @ 1:56ad4e20f292 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
"planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1"
author guerler
date Fri, 31 Jul 2020 00:32:28 -0400
parents
children
comparison
equal deleted inserted replaced
0:d30785e31577 1:56ad4e20f292
1 #!/usr/bin/env python3
2 # -*- coding: utf-8 -*-
3 #
4 # importlib_metadata documentation build configuration file, created by
5 # sphinx-quickstart on Thu Nov 30 10:21:00 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 # sys.path.insert(0, os.path.abspath('.'))
23
24
25 # -- General configuration ------------------------------------------------
26
27 # If your documentation needs a minimal Sphinx version, state it here.
28 #
29 # needs_sphinx = '1.0'
30
31 # Add any Sphinx extension module names here, as strings. They can be
32 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
33 # ones.
34 extensions = [
35 'rst.linker',
36 'sphinx.ext.autodoc',
37 'sphinx.ext.coverage',
38 'sphinx.ext.doctest',
39 'sphinx.ext.intersphinx',
40 'sphinx.ext.viewcode',
41 ]
42
43 # Add any paths that contain templates here, relative to this directory.
44 templates_path = ['_templates']
45
46 # The suffix(es) of source filenames.
47 # You can specify multiple suffix as a list of string:
48 #
49 # source_suffix = ['.rst', '.md']
50 source_suffix = '.rst'
51
52 # The master toctree document.
53 master_doc = 'index'
54
55 # General information about the project.
56 project = 'importlib_metadata'
57 copyright = '2017-2019, Jason R. Coombs, Barry Warsaw'
58 author = 'Jason R. Coombs, Barry Warsaw'
59
60 # The version info for the project you're documenting, acts as replacement for
61 # |version| and |release|, also used in various other places throughout the
62 # built documents.
63 #
64 # The short X.Y version.
65 version = '0.1'
66 # The full version, including alpha/beta/rc tags.
67 release = '0.1'
68
69 # The language for content autogenerated by Sphinx. Refer to documentation
70 # for a list of supported languages.
71 #
72 # This is also used if you do content translation via gettext catalogs.
73 # Usually you set "language" from the command line for these cases.
74 language = None
75
76 # List of patterns, relative to source directory, that match files and
77 # directories to ignore when looking for source files.
78 # This patterns also effect to html_static_path and html_extra_path
79 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
80
81 # The name of the Pygments (syntax highlighting) style to use.
82 pygments_style = 'sphinx'
83
84 # If true, `todo` and `todoList` produce output, else they produce nothing.
85 todo_include_todos = False
86
87
88 # -- Options for HTML output ----------------------------------------------
89
90 # The theme to use for HTML and HTML Help pages. See the documentation for
91 # a list of builtin themes.
92 #
93 html_theme = 'default'
94
95 # Custom sidebar templates, must be a dictionary that maps document names
96 # to template names.
97 #
98 # This is required for the alabaster theme
99 # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
100 html_sidebars = {
101 '**': [
102 'relations.html', # needs 'show_related': True theme option to display
103 'searchbox.html',
104 ]
105 }
106
107
108 # -- Options for HTMLHelp output ------------------------------------------
109
110 # Output file base name for HTML help builder.
111 htmlhelp_basename = 'importlib_metadatadoc'
112
113
114 # -- Options for LaTeX output ---------------------------------------------
115
116 latex_elements = {
117 # The paper size ('letterpaper' or 'a4paper').
118 #
119 # 'papersize': 'letterpaper',
120
121 # The font size ('10pt', '11pt' or '12pt').
122 #
123 # 'pointsize': '10pt',
124
125 # Additional stuff for the LaTeX preamble.
126 #
127 # 'preamble': '',
128
129 # Latex figure (float) alignment
130 #
131 # 'figure_align': 'htbp',
132 }
133
134 # Grouping the document tree into LaTeX files. List of tuples
135 # (source start file, target name, title,
136 # author, documentclass [howto, manual, or own class]).
137 latex_documents = [
138 (master_doc, 'importlib_metadata.tex',
139 'importlib\\_metadata Documentation',
140 'Brett Cannon, Barry Warsaw', 'manual'),
141 ]
142
143
144 # -- Options for manual page output ---------------------------------------
145
146 # One entry per manual page. List of tuples
147 # (source start file, name, description, authors, manual section).
148 man_pages = [
149 (master_doc, 'importlib_metadata', 'importlib_metadata Documentation',
150 [author], 1)
151 ]
152
153
154 # -- Options for Texinfo output -------------------------------------------
155
156 # Grouping the document tree into Texinfo files. List of tuples
157 # (source start file, target name, title, author,
158 # dir menu entry, description, category)
159 texinfo_documents = [
160 (master_doc, 'importlib_metadata', 'importlib_metadata Documentation',
161 author, 'importlib_metadata', 'One line description of project.',
162 'Miscellaneous'),
163 ]
164
165
166 # Example configuration for intersphinx: refer to the Python standard library.
167 intersphinx_mapping = {
168 'python': ('https://docs.python.org/3', None),
169 'importlib_resources': (
170 'https://importlib-resources.readthedocs.io/en/latest/', None
171 ),
172 }
173
174
175 # For rst.linker, inject release dates into changelog.rst
176 link_files = {
177 'changelog.rst': dict(
178 replace=[
179 dict(
180 pattern=r'^(?m)((?P<scm_version>v?\d+(\.\d+){1,2}))\n[-=]+\n',
181 with_scm='{text}\n{rev[timestamp]:%Y-%m-%d}\n\n',
182 ),
183 ],
184 ),
185 }