forked from abey79/vsketch
-
Notifications
You must be signed in to change notification settings - Fork 0
/
conf.py
111 lines (84 loc) · 3.26 KB
/
conf.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- Path setup --------------------------------------------------------------
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
# -- Project information -----------------------------------------------------
project = "vsketch"
copyright = "2020, Antoine Beyeler"
author = "Antoine Beyeler"
# -- General configuration ---------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
"sphinx_rtd_theme",
"sphinx.ext.autodoc",
"sphinx.ext.autosummary",
"sphinx.ext.napoleon",
"sphinx.ext.intersphinx",
"sphinx.ext.autosummary",
"sphinx_autodoc_typehints",
# "recommonmark",
# "autoapi.extension",
]
# -- Autodoc
autodoc_default_flags = ["members"]
autosummary_generate = True
add_module_names = False
autosummary_imported_members = True
# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "venv", ".*"]
# -- Global options ----------------------------------------------------------
# Don't mess with double-dash used in CLI options
smartquotes_action = "qe"
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = "sphinx_rtd_theme"
html_theme_options = {
# Toc options
# "collapse_navigation": False,
# "sticky_navigation": True,
"navigation_depth": 4,
# "titles_only": False,
}
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ["_static"]
# -- Intersphinx options
intersphinx_mapping = {
"shapely": ("https://shapely.readthedocs.io/en/latest/", None),
"vpype": ("https://vpype.readthedocs.io/en/latest/", None),
"python": ("https://docs.python.org/3/", None),
}
# -- Napoleon options
napoleon_include_init_with_doc = True
# noinspection PyUnusedLocal
def autodoc_skip_member(app, what, name, obj, skip, options):
exclusions = (
# vsketch/vsketch.py
"get_params",
"set_param_set",
"params",
"param_set",
)
is_private = name.startswith("_") and name != "__init__"
exclude = name in exclusions or is_private
return skip or exclude
def setup(app):
app.connect("autodoc-skip-member", autodoc_skip_member)