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
112
|
# 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 = "NXT-Python"
copyright = "2021-2025, Nicolas Schodet"
author = "Nicolas Schodet"
# The full version, including alpha/beta/rc tags
release = "3.5.1"
version = release
# -- General configuration ---------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#
needs_sphinx = "3.4"
# 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.ext.autodoc",
"sphinx.ext.intersphinx",
]
intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}
# 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"]
nitpicky = True
# -- 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_logo = "../logo.svg"
html_favicon = "favicon.ico"
html_copy_source = False
# -- Options for Man pages output --------------------------------------------
man_pages_authors = [
"This program is part of NXT-Python which is currently maintained by"
" Nicolas Schodet.",
]
man_pages = [
(
"config",
"nxt-python.conf",
"NXT-Python configuration file",
man_pages_authors,
5,
),
(
"commands/nxt-push",
"nxt-push",
"Push files to a NXT brick",
man_pages_authors,
1,
),
(
"commands/nxt-screenshot",
"nxt-screenshot",
"Capture screen utility for the NXT brick",
man_pages_authors,
1,
),
(
"commands/nxt-server",
"nxt-server",
"Network server for the NXT brick",
man_pages_authors,
1,
),
(
"commands/nxt-test",
"nxt-test",
"Test the NXT-Python setup",
man_pages_authors,
1,
),
]
# -- Options for autodoc -----------------------------------------------------
autodoc_member_order = "bysource"
autodoc_typehints = "description"
|
