Skip to content

Commit 943062b

Browse files
committed
moved column type docs into docstrings
1 parent 5084ce3 commit 943062b

File tree

6 files changed

+438
-578
lines changed

6 files changed

+438
-578
lines changed

docs/doc-requirements.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
Sphinx==2.1.2
2-
sphinx-rtd-theme==0.4.3
3-
livereload==2.6.1
1+
Sphinx==3.1.2
2+
sphinx-rtd-theme==0.5.0
3+
livereload==2.6.2

docs/src/conf.py

Lines changed: 5 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
import datetime
1616
import os
1717
import sys
18+
import typing as t
1819

1920
sys.path.insert(0, os.path.abspath("../.."))
2021

@@ -69,11 +70,14 @@
6970
# List of patterns, relative to source directory, that match files and
7071
# directories to ignore when looking for source files.
7172
# This pattern also affects html_static_path and html_extra_path.
72-
exclude_patterns = []
73+
exclude_patterns: t.List[str] = []
7374

7475
# The name of the Pygments (syntax highlighting) style to use.
7576
pygments_style = None
7677

78+
# -- Autodoc -----------------------------------------------------------------
79+
80+
autodoc_typehints = "signature"
7781

7882
# -- Options for HTML output -------------------------------------------------
7983

@@ -110,80 +114,13 @@
110114
htmlhelp_basename = "Piccolodoc"
111115

112116

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-
144117
# -- Options for manual page output ------------------------------------------
145118

146119
# One entry per manual page. List of tuples
147120
# (source start file, name, description, authors, manual section).
148121
man_pages = [(master_doc, "piccolo", "Piccolo Documentation", [author], 1)]
149122

150123

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-
187124
# -- Extension configuration -------------------------------------------------
188125

189126
# -- Options for todo extension ----------------------------------------------

0 commit comments

Comments
 (0)