Mercurial > circuitpython-badge

annotate docs/conf.py @ 4:7125a66d2f6d draft default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Typo
author Radomir Dopieralski <sheep-devel@sheep.art.pl>
date Sun, 19 Aug 2018 13:49:10 +0200
parents eff707b7a302
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
1 # -*- coding: utf-8 -*-
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
2 #
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
3 # Badge documentation build configuration file, created by
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
4 # sphinx-quickstart on Sun Aug 19 13:07:17 2018.
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
5 #
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
6 # This file is execfile()d with the current directory set to its
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
7 # containing dir.
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
8 #
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
9 # Note that not all possible configuration values are present in this
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
10 # autogenerated file.
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
11 #
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
12 # All configuration values have a default; values that are commented out
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
13 # serve to show the default.
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
14
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
15 # If extensions (or modules to document with autodoc) are in another directory,
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
16 # add these directories to sys.path here. If the directory is relative to the
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
17 # documentation root, use os.path.abspath to make it absolute, like shown here.
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
18 #
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
19 # import os
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
20 # import sys
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
21 # sys.path.insert(0, os.path.abspath('.'))
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
22
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
23
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
24 # -- General configuration ------------------------------------------------
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
25
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
26 # If your documentation needs a minimal Sphinx version, state it here.
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
27 #
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
28 # needs_sphinx = '1.0'
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
29
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
30 # Add any Sphinx extension module names here, as strings. They can be
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
31 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
32 # ones.
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
33 extensions = ['sphinx.ext.intersphinx',
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
34 'sphinx.ext.imgmath']
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
35
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
36 # Add any paths that contain templates here, relative to this directory.
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
37 templates_path = ['_templates']
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
38
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
39 # The suffix(es) of source filenames.
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
40 # You can specify multiple suffix as a list of string:
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
41 #
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
42 # source_suffix = ['.rst', '.md']
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
43 source_suffix = '.rst'
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
44
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
45 # The master toctree document.
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
46 master_doc = 'index'
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
47
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
48 # General information about the project.
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
49 project = u'Badge'
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
50 copyright = u'2018, Radomir Dopieralski'
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
51 author = u'Radomir Dopieralski'
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
52
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
53 # The version info for the project you're documenting, acts as replacement for
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
54 # |version| and |release|, also used in various other places throughout the
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
55 # built documents.
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
56 #
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
57 # The short X.Y version.
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
58 version = u'1'
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
59 # The full version, including alpha/beta/rc tags.
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
60 release = u'1'
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
61
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
62 # The language for content autogenerated by Sphinx. Refer to documentation
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
63 # for a list of supported languages.
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
64 #
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
65 # This is also used if you do content translation via gettext catalogs.
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
66 # Usually you set "language" from the command line for these cases.
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
67 language = None
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
68
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
69 # List of patterns, relative to source directory, that match files and
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
70 # directories to ignore when looking for source files.
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
71 # This patterns also effect to html_static_path and html_extra_path
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
72 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
73
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
74 # The name of the Pygments (syntax highlighting) style to use.
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
75 pygments_style = 'sphinx'
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
76
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
77 # If true, `todo` and `todoList` produce output, else they produce nothing.
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
78 todo_include_todos = False
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
79
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
80
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
81 # -- Options for HTML output ----------------------------------------------
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
82
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
83 # The theme to use for HTML and HTML Help pages. See the documentation for
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
84 # a list of builtin themes.
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
85 #
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
86 html_theme = 'alabaster'
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
87
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
88 # Theme options are theme-specific and customize the look and feel of a theme
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
89 # further. For a list of options available for each theme, see the
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
90 # documentation.
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
91 #
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
92 # html_theme_options = {}
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
93
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
94 # Add any paths that contain custom static files (such as style sheets) here,
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
95 # relative to this directory. They are copied after the builtin static files,
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
96 # so a file named "default.css" will overwrite the builtin "default.css".
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
97 html_static_path = ['_static']
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
98
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
99 # Custom sidebar templates, must be a dictionary that maps document names
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
100 # to template names.
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
101 #
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
102 # This is required for the alabaster theme
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
103 # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
104 html_sidebars = {
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
105 '**': [
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
106 'relations.html', # needs 'show_related': True theme option to display
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
107 'searchbox.html',
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
108 ]
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
109 }
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
110
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
111
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
112 # -- Options for HTMLHelp output ------------------------------------------
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
113
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
114 # Output file base name for HTML help builder.
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
115 htmlhelp_basename = 'Badgedoc'
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
116
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
117
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
118 # -- Options for LaTeX output ---------------------------------------------
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
119
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
120 latex_elements = {
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
121 # The paper size ('letterpaper' or 'a4paper').
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
122 #
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
123 # 'papersize': 'letterpaper',
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
124
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
125 # The font size ('10pt', '11pt' or '12pt').
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
126 #
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
127 # 'pointsize': '10pt',
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
128
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
129 # Additional stuff for the LaTeX preamble.
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
130 #
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
131 # 'preamble': '',
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
132
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
133 # Latex figure (float) alignment
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
134 #
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
135 # 'figure_align': 'htbp',
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
136 }
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
137
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
138 # Grouping the document tree into LaTeX files. List of tuples
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
139 # (source start file, target name, title,
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
140 # author, documentclass [howto, manual, or own class]).
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
141 latex_documents = [
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
142 (master_doc, 'Badge.tex', u'Badge Documentation',
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
143 u'Radomir Dopieralski', 'manual'),
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
144 ]
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
145
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
146
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
147 # -- Options for manual page output ---------------------------------------
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
148
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
149 # One entry per manual page. List of tuples
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
150 # (source start file, name, description, authors, manual section).
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
151 man_pages = [
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
152 (master_doc, 'badge', u'Badge Documentation',
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
153 [author], 1)
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
154 ]
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
155
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
156
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
157 # -- Options for Texinfo output -------------------------------------------
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
158
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
159 # Grouping the document tree into Texinfo files. List of tuples
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
160 # (source start file, target name, title, author,
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
161 # dir menu entry, description, category)
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
162 texinfo_documents = [
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
163 (master_doc, 'Badge', u'Badge Documentation',
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
164 author, 'Badge', 'One line description of project.',
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
165 'Miscellaneous'),
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
166 ]
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
167
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
168
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
169
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
170
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
171 # Example configuration for intersphinx: refer to the Python standard library.
eff707b7a302 Initial docs
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
172 intersphinx_mapping = {'https://docs.python.org/': None}