-
Notifications
You must be signed in to change notification settings - Fork 186
/
conf.py
96 lines (78 loc) · 2.66 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
# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
import os
import sys
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
project = "Pymunk"
copyright = "2013-2022, Victor Blomqvist"
author = "Victor Blomqvist"
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
sys.path.append(os.path.abspath("."))
sys.path.append(os.path.abspath("../.."))
extensions = [ #'sphinx.ext.autodoc',
"sphinx.ext.viewcode",
"sphinx.ext.autosummary",
"ext.autoexample",
"aafigure.sphinxext",
]
templates_path = ["_templates"]
exclude_patterns = []
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
html_theme = "alabaster"
html_static_path = ["_static"]
# Font
html_theme_options = {
"font_family": '"Lucida Grande",Arial,sans-serif',
"head_font_family": '"Lucida Grande",Arial,sans-serif',
}
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
html_logo = "_static/pymunk_logo_sphinx.png"
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
html_favicon = "_static/pymunk_favicon.ico"
# Custom sidebar templates, maps document names to template names.
html_sidebars = {
"**": [
"badges.html",
"globaltoc.html",
"relations.html",
"sourcelink.html",
"searchbox.html",
],
}
html_js_files = [
(
"//gc.zgo.at/count.js",
{"async": "async", "data-goatcounter": "https://pymunk.goatcounter.com/count"},
)
]
# -- Other ------------------------------------------------------------------
autodoc_default_options = {
"members": True,
"undoc-members": True,
"show-inheritance": True,
"inherited-members": True,
# "member-order": "bysource",
# "special-members": "__init__, __add__"
#'exclude-members': '__weakref__'
"exclude-members": "index, count",
}
autodoc_preserve_defaults = True
autodoc_mock_imports = [
"_chipmunk_cffi", # mock to make enums like DYNAMIC be documented properly
"pymunk._chipmunk",
"_cffi_backend",
"matplotlib",
"matplotlib.pyplot",
"pygame",
"pygame.locals",
"pygame.color",
"pyglet",
]