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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
{
lib,
buildPythonPackage,
pythonAtLeast,
pythonOlder,
fetchFromGitHub,
isPyPy,
# build-system
flit-core,
# dependencies
babel,
alabaster,
docutils,
imagesize,
jinja2,
packaging,
pygments,
requests,
roman-numerals-py,
snowballstemmer,
sphinxcontrib-applehelp,
sphinxcontrib-devhelp,
sphinxcontrib-htmlhelp,
sphinxcontrib-jsmath,
sphinxcontrib-qthelp,
sphinxcontrib-serializinghtml,
sphinxcontrib-websupport,
tomli,
# check phase
defusedxml,
filelock,
html5lib,
pytestCheckHook,
pytest-xdist,
typing-extensions,
writableTmpDirAsHomeHook,
# reverse dependencies to test
breathe,
}:
buildPythonPackage rec {
pname = "sphinx";
version = "8.2.3";
pyproject = true;
disabled = pythonOlder "3.11";
src = fetchFromGitHub {
owner = "sphinx-doc";
repo = "sphinx";
tag = "v${version}";
postFetch = ''
# Change ä to æ in file names, since ä can be encoded multiple ways on different
# filesystems, leading to different hashes on different platforms.
cd "$out";
mv tests/roots/test-images/{testimäge,testimæge}.png
sed -i 's/testimäge/testimæge/g' tests/{test_build*.py,roots/test-images/index.rst}
'';
hash = "sha256-FoyCpDGDKNN2GMhE7gDpJLmWRWhbMCYlcVEaBTfXSEw=";
};
build-system = [ flit-core ];
dependencies = [
alabaster
babel
docutils
imagesize
jinja2
packaging
pygments
requests
roman-numerals-py
snowballstemmer
sphinxcontrib-applehelp
sphinxcontrib-devhelp
sphinxcontrib-htmlhelp
sphinxcontrib-jsmath
sphinxcontrib-qthelp
sphinxcontrib-serializinghtml
# extra[docs]
sphinxcontrib-websupport
]
++ lib.optionals (pythonOlder "3.11") [ tomli ];
__darwinAllowLocalNetworking = true;
nativeCheckInputs = [
defusedxml
filelock
html5lib
pytestCheckHook
pytest-xdist
typing-extensions
writableTmpDirAsHomeHook
];
disabledTestPaths = lib.optionals isPyPy [
# internals are asserted which are sightly different in PyPy
"tests/test_extensions/test_ext_autodoc.py"
"tests/test_extensions/test_ext_autodoc_autoclass.py"
"tests/test_extensions/test_ext_autodoc_autofunction.py"
"tests/test_extensions/test_ext_autodoc_automodule.py"
"tests/test_extensions/test_ext_autodoc_preserve_defaults.py"
"tests/test_util/test_util_inspect.py"
"tests/test_util/test_util_typing.py"
];
disabledTests = [
# requires network access
"test_latex_images"
# racy
"test_defaults"
"test_check_link_response_only"
"test_anchors_ignored_for_url"
"test_autodoc_default_options"
"test_too_many_requests_retry_after_int_delay"
# racy with pytest-xdist
"test_domain_cpp_build_semicolon"
"test_class_alias"
"test_class_alias_having_doccomment"
"test_class_alias_for_imported_object_having_doccomment"
"test_decorators"
"test_xml_warnings"
# racy with too many threads
# https://github.com/NixOS/nixpkgs/issues/353176
"test_document_toc_only"
# Assertion error
"test_gettext_literalblock_additional"
# Could not fetch remote image: http://localhost:7777/sphinx.png
"test_copy_images"
# ModuleNotFoundError: No module named 'fish_licence.halibut'
"test_import_native_module_stubs"
# Racy tex file creation
"test_literalinclude_namedlink_latex"
"test_literalinclude_caption_latex"
# Racy local networking
"test_load_mappings_cache"
"test_load_mappings_cache_update"
"test_load_mappings_cache_revert_update"
]
++ lib.optionals (pythonAtLeast "3.14") [
"test_autodoc_special_members"
"test_is_invalid_builtin_class"
"test_autosummary_generate_content_for_module_imported_members"
]
++ lib.optionals isPyPy [
# PyPy has not __builtins__ which get asserted
# https://doc.pypy.org/en/latest/cpython_differences.html#miscellaneous
"test_autosummary_generate_content_for_module"
"test_autosummary_generate_content_for_module_skipped"
# Struct vs struct.Struct
"test_restify"
"test_stringify_annotation"
"test_stringify_type_union_operator"
];
passthru.tests = {
inherit breathe;
};
meta = {
description = "Python documentation generator";
longDescription = ''
Sphinx makes it easy to create intelligent and beautiful documentation.
Here are some of Sphinx’s major features:
- Output formats: HTML (including Windows HTML Help), LaTeX (for printable
PDF versions), ePub, Texinfo, manual pages, plain text
- Extensive cross-references: semantic markup and automatic links for
functions, classes, citations, glossary terms and similar pieces of
information
- Hierarchical structure: easy definition of a document tree, with
automatic links to siblings, parents and children
- Automatic indices: general index as well as a language-specific module
indices
- Code handling: automatic highlighting using the Pygments highlighter
- Extensions: automatic testing of code snippets, inclusion of docstrings
from Python modules (API docs) via built-in extensions, and much more
functionality via third-party extensions.
- Themes: modify the look and feel of outputs via creating themes, and
re-use many third-party themes.
- Contributed extensions: dozens of extensions contributed by users; most
of them installable from PyPI.
Sphinx uses the reStructuredText markup language by default, and can read
MyST markdown via third-party extensions. Both of these are powerful and
straightforward to use, and have functionality for complex documentation
and publishing workflows. They both build upon Docutils to parse and write
documents.
'';
homepage = "https://www.sphinx-doc.org";
changelog = "https://www.sphinx-doc.org/en/master/changes.html";
license = lib.licenses.bsd3;
};
}
|
