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
|
import os
import re
import sys
RTD_BUILD = os.environ.get('READTHEDOCS') == 'True'
# 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
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
project = 'PyArtNet'
copyright = '2025, spacemanspiff2007'
author = 'spacemanspiff2007'
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
extensions = [
'sphinx_exec_code',
'sphinx.ext.autodoc',
'sphinx.ext.intersphinx',
'sphinx_autodoc_typehints',
]
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 = 'sphinx_rtd_theme'
# -- Options for exec code -------------------------------------------------
exec_code_working_dir = '../src'
exec_code_source_folders = ['../src', '../tests']
# -- Options for autodoc -------------------------------------------------
autodoc_member_order = 'bysource'
autoclass_content = 'class'
# required for autodoc
sys.path.insert(0, os.path.join(os.path.abspath('..'), 'src'))
# -- Options for intersphinx -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html
if RTD_BUILD:
intersphinx_mapping = {
'python': ('https://docs.python.org/3', None)
}
# -- Options for nitpick -------------------------------------------------
nitpick_ignore_regex = [
(re.compile(r'py:class'), re.compile(r'pyartnet\.fades\.fade_base\.FadeBase'))
]
# Don't show warnings for missing python references since these are created via intersphinx during the RTD build
if not RTD_BUILD:
nitpick_ignore_regex.append(
(re.compile(r'py:data|py:class'), re.compile(r'typing\..+'))
)
nitpick_ignore_regex.append(
(re.compile(r'py:class'), re.compile(r'collections\.abc\..+'))
)
|
