|
15 | 15 | import datetime |
16 | 16 | import os |
17 | 17 | import sys |
| 18 | +import typing as t |
18 | 19 |
|
19 | 20 | sys.path.insert(0, os.path.abspath("../..")) |
20 | 21 |
|
|
69 | 70 | # List of patterns, relative to source directory, that match files and |
70 | 71 | # directories to ignore when looking for source files. |
71 | 72 | # This pattern also affects html_static_path and html_extra_path. |
72 | | -exclude_patterns = [] |
| 73 | +exclude_patterns: t.List[str] = [] |
73 | 74 |
|
74 | 75 | # The name of the Pygments (syntax highlighting) style to use. |
75 | 76 | pygments_style = None |
76 | 77 |
|
| 78 | +# -- Autodoc ----------------------------------------------------------------- |
| 79 | + |
| 80 | +autodoc_typehints = "signature" |
77 | 81 |
|
78 | 82 | # -- Options for HTML output ------------------------------------------------- |
79 | 83 |
|
|
110 | 114 | htmlhelp_basename = "Piccolodoc" |
111 | 115 |
|
112 | 116 |
|
113 | | -# -- Options for LaTeX output ------------------------------------------------ |
114 | | - |
115 | | -latex_elements = { |
116 | | - # The paper size ('letterpaper' or 'a4paper'). |
117 | | - # |
118 | | - # 'papersize': 'letterpaper', |
119 | | - # The font size ('10pt', '11pt' or '12pt'). |
120 | | - # |
121 | | - # 'pointsize': '10pt', |
122 | | - # Additional stuff for the LaTeX preamble. |
123 | | - # |
124 | | - # 'preamble': '', |
125 | | - # Latex figure (float) alignment |
126 | | - # |
127 | | - # 'figure_align': 'htbp', |
128 | | -} |
129 | | - |
130 | | -# Grouping the document tree into LaTeX files. List of tuples |
131 | | -# (source start file, target name, title, |
132 | | -# author, documentclass [howto, manual, or own class]). |
133 | | -latex_documents = [ |
134 | | - ( |
135 | | - master_doc, |
136 | | - "Piccolo.tex", |
137 | | - "Piccolo Documentation", |
138 | | - "Daniel Townsend", |
139 | | - "manual", |
140 | | - ), |
141 | | -] |
142 | | - |
143 | | - |
144 | 117 | # -- Options for manual page output ------------------------------------------ |
145 | 118 |
|
146 | 119 | # One entry per manual page. List of tuples |
147 | 120 | # (source start file, name, description, authors, manual section). |
148 | 121 | man_pages = [(master_doc, "piccolo", "Piccolo Documentation", [author], 1)] |
149 | 122 |
|
150 | 123 |
|
151 | | -# -- Options for Texinfo output ---------------------------------------------- |
152 | | - |
153 | | -# Grouping the document tree into Texinfo files. List of tuples |
154 | | -# (source start file, target name, title, author, |
155 | | -# dir menu entry, description, category) |
156 | | -texinfo_documents = [ |
157 | | - ( |
158 | | - master_doc, |
159 | | - "Piccolo", |
160 | | - "Piccolo Documentation", |
161 | | - author, |
162 | | - "Piccolo", |
163 | | - "One line description of project.", |
164 | | - "Miscellaneous", |
165 | | - ), |
166 | | -] |
167 | | - |
168 | | - |
169 | | -# -- Options for Epub output ------------------------------------------------- |
170 | | - |
171 | | -# Bibliographic Dublin Core info. |
172 | | -epub_title = project |
173 | | - |
174 | | -# The unique identifier of the text. This can be a ISBN number |
175 | | -# or the project homepage. |
176 | | -# |
177 | | -# epub_identifier = '' |
178 | | - |
179 | | -# A unique identification for the text. |
180 | | -# |
181 | | -# epub_uid = '' |
182 | | - |
183 | | -# A list of files that should not be packed into the epub file. |
184 | | -epub_exclude_files = ["search.html"] |
185 | | - |
186 | | - |
187 | 124 | # -- Extension configuration ------------------------------------------------- |
188 | 125 |
|
189 | 126 | # -- Options for todo extension ---------------------------------------------- |
|
0 commit comments