doc/conf.py

Mon, 04 Jun 2018 22:28:05 +0200

author
David Douard <david.douard@logilab.fr>
date
Mon, 04 Jun 2018 22:28:05 +0200
changeset 109
c2d93abebab3
parent 95
c6b655d9b855
permissions
-rw-r--r--

[plotter] add a --mockup option to the demo main function

92
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
1 # -*- coding: utf-8 -*-
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
2 #
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
3 # Configuration file for the Sphinx documentation builder.
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
4 #
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
5 # This file does only contain a selection of the most common options. For a
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
6 # full list see the documentation:
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
7 # http://www.sphinx-doc.org/en/master/config
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
8
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
9 # -- Path setup --------------------------------------------------------------
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
10
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
11 # If extensions (or modules to document with autodoc) are in another directory,
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
12 # add these directories to sys.path here. If the directory is relative to the
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
13 # documentation root, use os.path.abspath to make it absolute, like shown here.
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
14 #
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
15 # import os
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
16 # import sys
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
17 # sys.path.insert(0, os.path.abspath('.'))
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
18
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
19
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
20 # -- Project information -----------------------------------------------------
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
21
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
22 project = 'pygpibtoolkit'
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
23 copyright = '2018, David Douard'
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
24 author = 'David Douard'
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
25
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
26 # The short X.Y version
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
27 version = ''
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
28 # The full version, including alpha/beta/rc tags
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
29 release = '0.1.0'
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
30
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
31
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
32 # -- General configuration ---------------------------------------------------
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
33
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
34 # If your documentation needs a minimal Sphinx version, state it here.
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
35 #
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
36 # needs_sphinx = '1.0'
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
37
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
38 # Add any Sphinx extension module names here, as strings. They can be
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
39 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
40 # ones.
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
41 extensions = [
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
42 'sphinx.ext.autodoc',
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
43 'sphinx.ext.todo',
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
44 'sphinx.ext.viewcode',
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
45 ]
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
46
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
47 # Add any paths that contain templates here, relative to this directory.
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
48 templates_path = ['_templates']
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
49
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
50 # The suffix(es) of source filenames.
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
51 # You can specify multiple suffix as a list of string:
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
52 #
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
53 # source_suffix = ['.rst', '.md']
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
54 source_suffix = '.rst'
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
55
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
56 # The master toctree document.
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
57 master_doc = 'index'
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
58
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
59 # The language for content autogenerated by Sphinx. Refer to documentation
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
60 # for a list of supported languages.
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
61 #
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
62 # This is also used if you do content translation via gettext catalogs.
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
63 # Usually you set "language" from the command line for these cases.
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
64 language = None
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
65
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
66 # List of patterns, relative to source directory, that match files and
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
67 # directories to ignore when looking for source files.
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
68 # This pattern also affects html_static_path and html_extra_path .
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
69 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
70
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
71 # The name of the Pygments (syntax highlighting) style to use.
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
72 pygments_style = 'sphinx'
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
73
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
74
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
75 # -- Options for HTML output -------------------------------------------------
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
76
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
77 # The theme to use for HTML and HTML Help pages. See the documentation for
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
78 # a list of builtin themes.
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
79 #
95
c6b655d9b855 [doc] refactor a bit the doc and use classic theme
David Douard <david.douard@logilab.fr>
parents: 92
diff changeset
80 #html_theme = 'alabaster'
c6b655d9b855 [doc] refactor a bit the doc and use classic theme
David Douard <david.douard@logilab.fr>
parents: 92
diff changeset
81 html_theme = 'classic'
c6b655d9b855 [doc] refactor a bit the doc and use classic theme
David Douard <david.douard@logilab.fr>
parents: 92
diff changeset
82 html_logo = '_static/pygpibtoolkit.png'
92
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
83
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
84 # Theme options are theme-specific and customize the look and feel of a theme
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
85 # further. For a list of options available for each theme, see the
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
86 # documentation.
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
87 #
95
c6b655d9b855 [doc] refactor a bit the doc and use classic theme
David Douard <david.douard@logilab.fr>
parents: 92
diff changeset
88 html_theme_options = {
c6b655d9b855 [doc] refactor a bit the doc and use classic theme
David Douard <david.douard@logilab.fr>
parents: 92
diff changeset
89 # 'logo': 'pygpibtoolkit.png',
c6b655d9b855 [doc] refactor a bit the doc and use classic theme
David Douard <david.douard@logilab.fr>
parents: 92
diff changeset
90 # 'logo_name': True,
c6b655d9b855 [doc] refactor a bit the doc and use classic theme
David Douard <david.douard@logilab.fr>
parents: 92
diff changeset
91 # 'description': 'pygpibtoolkit',
c6b655d9b855 [doc] refactor a bit the doc and use classic theme
David Douard <david.douard@logilab.fr>
parents: 92
diff changeset
92 }
92
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
93
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
94 # Add any paths that contain custom static files (such as style sheets) here,
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
95 # relative to this directory. They are copied after the builtin static files,
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
96 # so a file named "default.css" will overwrite the builtin "default.css".
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
97 html_static_path = ['_static']
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
98
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
99 # Custom sidebar templates, must be a dictionary that maps document names
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
100 # to template names.
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
101 #
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
102 # The default sidebars (for documents that don't match any pattern) are
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
103 # defined by theme itself. Builtin themes are using these templates by
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
104 # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
105 # 'searchbox.html']``.
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
106 #
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
107 # html_sidebars = {}
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
108
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
109
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
110 # -- Options for HTMLHelp output ---------------------------------------------
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
111
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
112 # Output file base name for HTML help builder.
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
113 htmlhelp_basename = 'pygpibtoolkitdoc'
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
114
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
115
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
116 # -- Options for LaTeX output ------------------------------------------------
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
117
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
118 latex_elements = {
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
119 # The paper size ('letterpaper' or 'a4paper').
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
120 #
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
121 # 'papersize': 'letterpaper',
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
122
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
123 # The font size ('10pt', '11pt' or '12pt').
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
124 #
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
125 # 'pointsize': '10pt',
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
126
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
127 # Additional stuff for the LaTeX preamble.
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
128 #
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
129 # 'preamble': '',
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
130
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
131 # Latex figure (float) alignment
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
132 #
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
133 # 'figure_align': 'htbp',
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
134 }
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
135
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
136 # Grouping the document tree into LaTeX files. List of tuples
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
137 # (source start file, target name, title,
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
138 # author, documentclass [howto, manual, or own class]).
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
139 latex_documents = [
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
140 (master_doc, 'pygpibtoolkit.tex', 'pygpibtoolkit Documentation',
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
141 'David Douard', 'manual'),
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
142 ]
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
143
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
144
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
145 # -- Options for manual page output ------------------------------------------
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
146
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
147 # One entry per manual page. List of tuples
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
148 # (source start file, name, description, authors, manual section).
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
149 man_pages = [
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
150 (master_doc, 'pygpibtoolkit', 'pygpibtoolkit Documentation',
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
151 [author], 1)
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
152 ]
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
153
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
154
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
155 # -- Options for Texinfo output ----------------------------------------------
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
156
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
157 # Grouping the document tree into Texinfo files. List of tuples
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
158 # (source start file, target name, title, author,
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
159 # dir menu entry, description, category)
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
160 texinfo_documents = [
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
161 (master_doc, 'pygpibtoolkit', 'pygpibtoolkit Documentation',
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
162 author, 'pygpibtoolkit', 'One line description of project.',
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
163 'Miscellaneous'),
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
164 ]
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
165
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
166
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
167 # -- Extension configuration -------------------------------------------------
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
168
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
169 # -- Options for todo extension ----------------------------------------------
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
170
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
171 # If true, `todo` and `todoList` produce output, else they produce nothing.
95
c6b655d9b855 [doc] refactor a bit the doc and use classic theme
David Douard <david.douard@logilab.fr>
parents: 92
diff changeset
172 todo_include_todos = True

mercurial