File python-Sphinx.changes of Package python-Sphinx
3589
1
-------------------------------------------------------------------
2
Thu Sep 14 10:17:06 UTC 2023 - Dirk Müller <dmueller@suse.com>
3
4
- update to 7.2.6:
5
* #11679: Add the :envvar:`!SPHINX_AUTODOC_RELOAD_MODULES`
6
environment variable, which if set reloads modules when
7
using autodoc with ``TYPE_CHECKING = True``.
8
* #11679: Use :py:func:`importlib.reload` to reload modules in
9
autodoc.
10
11
-------------------------------------------------------------------
12
Thu Sep 7 10:45:56 UTC 2023 - Dirk Müller <dmueller@suse.com>
13
14
- update to 7.2.5:
15
* #11645: Fix a regression preventing autodoc from importing
16
modules within packages that make use of
17
``if typing.TYPE_CHECKING:`` to guard circular imports
18
needed by type checkers.
19
* #11634: Fixed inheritance diagram relative link resolution
20
for sibling files in a subdirectory.
21
* #11659: Allow ``?config=...`` in :confval:`mathjax_path`.
22
* #11654: autodoc: Fail with a more descriptive error message
23
when an object claims to be an instance of ``type``,
24
but is not a class.
25
* 11620: Cease emitting :event:`source-read` events for files
26
read via the :dudir:`include` directive.
27
* 11620: Add a new :event:`include-read` for observing and
28
transforming the content of included files via the :dudir:`include`
29
directive.
30
* #11627: Restore support for copyright lines of the form
31
``YYYY`` when ``SOURCE_DATE_EPOCH`` is set.
32
33
-------------------------------------------------------------------
34
Wed Aug 30 11:31:33 UTC 2023 - Markéta Machová <mmachova@suse.com>
35
36
- update to 7.2.4
37
* Require sphinxcontrib-serializinghtml 1.1.9.
38
* Fix regression in autodoc.Documenter.parse_name().
39
* Fix regression in JSON serialisation.
40
* autodoc: Support positional-only parameters in classmethod methods
41
when autodoc_preserve_defaults is True.
42
* Restore support string methods on path objects. This is deprecated
43
and will be removed in Sphinx 8. Use os.fspath() to convert Path
44
objects to strings, or Path’s methods to work with path objects.
45
* Fix a regression in the MoveModuleTargets transform.
46
* linkcheck: Resolve hanging tests for timezones west of London and
47
incorrect conversion from UTC to offsets from the UNIX epoch.
48
49
-------------------------------------------------------------------
50
Wed Aug 23 12:06:50 UTC 2023 - Markéta Machová <mmachova@suse.com>
51
52
- update to 7.2.2
53
* Drop Python 3.8 support.
54
* Require Pygments 2.14 or later.
55
* Deprecate sphinx.util.md5 and sphinx.util.sha1. Use hashlib instead.
56
* Deprecate sphinx.testing.path. Use os.path or pathlib instead.
57
* Support os.PathLike types and pathlib.Path objects in many more places.
58
* Add the :no-typesetting: option to suppress textual output and only
59
create a linkable anchor.
60
* Allow running Sphinx with python -m sphinx build
61
* graphviz: Fix relative links from within the graph.
62
* pytest: Fail tests on “XPASS”, Set PYTHONWARNINGS=error, set strict config
63
* Restored the the str interface of the asset classes (_CascadingStyleSheet
64
and _JavaScript), which several extensions relied upon. This will be
65
removed in Sphinx 9.
66
* Many more changes (even deprecations), see upstream changelog
67
68
-------------------------------------------------------------------
69
Mon Aug 7 08:18:59 UTC 2023 - Dirk Müller <dmueller@suse.com>
70
71
- update to 7.1.2:
72
* #11542: linkcheck: Properly respect :confval:`linkcheck_anchors`
73
and do not spuriously report failures to validate anchors.
74
75
-------------------------------------------------------------------
76
Fri Jul 28 13:34:59 UTC 2023 - Martin Liška <martin.liska@hey.com>
77
78
- Update to 7.1.1:
79
* #11514: Fix ``SOURCE_DATE_EPOCH`` in multi-line copyright footer.
80
Patch by Bénédikt Tran.
81
82
- Update to 7.1.0:
83
* Releases are no longer signed, given the `change in PyPI policy`_.
84
* #11412: Emit warnings on using a deprecated Python-specific index entry type
85
(namely, ``module``, ``keyword``, ``operator``, ``object``, ``exception``,
86
``statement``, and ``builtin``) in the :rst:dir:`index` directive, and
87
set the removal version to Sphinx 9. Patch by Adam Turner.
88
* #11415: Add a checksum to JavaScript and CSS asset URIs included within
89
generated HTML, using the CRC32 algorithm.
90
* :meth:`~sphinx.application.Sphinx.require_sphinx` now allows the version
91
requirement to be specified as ``(major, minor)``.
92
* #11011: Allow configuring a line-length limit for object signatures, via
93
:confval:`maximum_signature_line_length` and the domain-specific variants.
94
If the length of the signature (in characters) is greater than the configured
95
limit, each parameter in the signature will be split to its own logical line.
96
This behaviour may also be controlled by options on object description
97
directives, for example :rst:dir:`py:function:single-line-parameter-list`.
98
Patch by Thomas Louf, Adam Turner, and Jean-François B.
99
* #10983: Support for multiline copyright statements in the footer block.
100
Patch by Stefanie Molin
101
* ``sphinx.util.display.status_iterator`` now clears the current line
102
with ANSI control codes, rather than overprinting with space characters.
103
* #11431: linkcheck: Treat SSL failures as broken links.
104
Patch by Bénédikt Tran
105
* #11157: Keep the ``translated`` attribute on translated nodes.
106
* #11451: Improve the traceback displayed when using :option:`sphinx-build -T`
107
in parallel builds. Patch by Bénédikt Tran
108
* #11324: linkcheck: Use session-basd HTTP requests.
109
* #11438: Add support for the :rst:dir:`py:class` and :rst:dir:`py:function`
110
directives for PEP 695 (generic classes and functions declarations) and
111
PEP 696 (default type parameters). Multi-line support (#11011) is enabled
112
for type parameters list and can be locally controlled on object description
113
directives, e.g., :rst:dir:`py:function:single-line-type-parameter-list`.
114
Patch by Bénédikt Tran.
115
* #11484: linkcheck: Allow HTML anchors to be ignored on a per-URL basis
116
via :confval:`linkcheck_anchors_ignore_for_url` while
117
still checking the validity of the page itself.
118
Patch by Bénédikt Tran
119
* #1246: Add translation progress statistics and inspection support,
120
via a new substitution (``|translation progress|``) and a new
121
configuration variable (:confval:`translation_progress_classes`).
122
These enable determining the percentage of translated elements within
123
a document, and the remaining translated and untranslated elements.
124
* Restored the ``footnote-reference`` class that has been removed in
125
the latest (unreleased) version of Docutils.
126
* #11486: Use :rfc:`8081` font file MIME types in the EPUB builder.
127
Using the correct MIME type will prevent warnings from ``epubcheck``
128
and will generate a valid EPUB.
129
* #11435: Use microsecond-resolution timestamps for outdated file detection
130
in ``BuildEnvironment.get_outdated_files``.
131
* #11437: Top-level headings starting with a reStructuredText role
132
now render properly when :confval:`rst_prolog` is set.
133
Previously, a file starting with the below would have
134
improperly rendered due to where the prologue text
135
was inserted into the document.
136
Patch by Bénédikt Tran.
137
* #11337: Fix a ``MemoryError`` in ``sphinx.ext.intersphinx`` when using ``None``
138
or ``typing.*`` as inline type references. Patch by Bénédikt Tran (picnixz)
139
* #11345: Always delete ``docutils.conf`` in test directories when running
140
``SphinxTestApp.cleanup()``.
141
142
-------------------------------------------------------------------
143
Sun May 14 15:27:42 UTC 2023 - Dirk Müller <dmueller@suse.com>
144
145
- update to 7.0.1:
146
* Support `Docutils 0.20`_.
147
* #11418: Clean up remaining references to
148
``sphinx.setup_command``
149
following the removal of support for setuptools.
150
151
-------------------------------------------------------------------
152
Sun Apr 30 07:40:26 UTC 2023 - Martin Liška <mliska@suse.cz>
153
154
- Update to version 7.0.0
155
* #11359: Remove long-deprecated aliases for ``MecabSplitter`` and
156
``DefaultSplitter`` in ``sphinx.search.ja``.
157
* #11360: Remove deprecated ``make_old_id`` functions in domain object
158
description classes.
159
* #11363: Remove the Setuptools integration (``build_sphinx`` hook in
160
``setup.py``).
161
* #11364: Remove deprecated ``sphinx.ext.napoleon.iterators`` module.
162
* #11365: Remove support for the ``jsdump`` format in ``sphinx.search``.
163
* #11366: Make ``locale`` a required argument to
164
``sphinx.util.i18n.format_date()``.
165
* #11370: Remove deprecated ``sphinx.util.stemmer`` module.
166
* #11371: Remove deprecated ``sphinx.pycode.ast.parse()`` function.
167
* #11372: Remove deprecated ``sphinx.io.read_doc()`` function.
168
* #11373: Removed deprecated ``sphinx.util.get_matching_files()`` function.
169
* #11378: Remove deprecated ``sphinx.util.docutils.is_html5_writer_available()``
170
function.
171
* #11379: Make the ``env`` argument to ``Builder`` subclasses required.
172
* #11380: autosummary: Always emit grouped import exceptions.
173
* #11381: Remove deprecated ``style`` key for HTML templates.
174
* #11382: Remove deprecated ``sphinx.writers.latex.LaTeXTranslator.docclasses``
175
attribute.
176
* #11383: Remove deprecated ``sphinx.builders.html.html5_ready`` and
177
``sphinx.builders.html.HTMLTranslator`` attributes.
178
* #11385: Remove support for HTML 4 output.
179
180
-------------------------------------------------------------------
181
Wed Apr 26 16:21:27 UTC 2023 - Matej Cepl <mcepl@suse.com>
182
183
- For PSP packages don't include documentation at all. The
184
building of Sphinx documentation is so complicated, that it is
185
not possible to include it in the main package.
186
187
-------------------------------------------------------------------
188
Tue Apr 25 11:17:16 UTC 2023 - Martin Liška <mliska@suse.cz>
189
190
- Update to version 6.2.1
191
* #11355: Revert the default type of :confval:`nitpick_ignore` and
192
:confval:`nitpick_ignore_regex` to ``list``.
193
194
-------------------------------------------------------------------
195
Mon Apr 24 07:40:28 UTC 2023 - Martin Liška <mliska@suse.cz>
196
197
- Bump to version 6.2.0
198
* Require Docutils 0.18.1 or greater.
199
* LaTeX: removal of some internal TeX ``\dimen`` registers (not previously
200
publicly documented) as per 5.1.0 code comments in ``sphinx.sty``:
201
``\sphinxverbatimsep``, ``\sphinxverbatimborder``, ``\sphinxshadowsep``,
202
``\sphinxshadowsize``, and ``\sphinxshadowrule``. (refs: #11105)
203
* Remove ``.egg`` support from pycode ``ModuleAnalyser``; Python eggs are a
204
now-obsolete binary distribution format
205
* #11089: Remove deprecated code in ``sphinx.builders.linkcheck``.
206
Patch by Daniel Eades
207
* Remove internal-only ``sphinx.locale.setlocale``
208
* #11247: Deprecate the legacy ``intersphinx_mapping`` format
209
* ``sphinx.util.osutil.cd`` is deprecated in favour of ``contextlib.chdir``.
210
* #11277: :rst:dir:`autoproperty` allows the return type to be specified as
211
a type comment (e.g., ``# type: () -> int``). Patch by Bénédikt Tran
212
* #10811: Autosummary: extend ``__all__`` to imported members for template rendering
213
when option ``autosummary_ignore_module_all`` is set to ``False``. Patch by
214
Clement Pinard
215
* #11147: Add a ``content_offset`` parameter to ``nested_parse_with_titles()``,
216
allowing for correct line numbers during nested parsing.
217
Patch by Jeremy Maitin-Shepard
218
* Update to Unicode CLDR 42
219
* Add a ``--jobs`` synonym for ``-j``. Patch by Hugo van Kemenade
220
* LaTeX: a command ``\sphinxbox`` for styling text elements with a (possibly
221
rounded) box, optional background color and shadow, has been added.
222
See :ref:`sphinxbox`. (refs: #11224)
223
* LaTeX: add ``\sphinxstylenotetitle``, ..., ``\sphinxstylewarningtitle``, ...,
224
for an extra layer of mark-up freeing up ``\sphinxstrong`` for other uses.
225
See :ref:`latex-macros`. (refs: #11267)
226
* LaTeX: :dudir:`note`, :dudir:`hint`, :dudir:`important` and :dudir:`tip` can
227
now each be styled as the other admonitions, i.e. possibly with a background
228
color, individual border widths and paddings, possibly rounded corners, and
229
optional shadow. See :ref:`additionalcss`. (refs: #11234)
230
* LaTeX: admonitions and :dudir:`topic` (and
231
:dudir:`contents <table-of-contents>`) directives, and not only
232
:rst:dir:`code-block`, support ``box-decoration-break=slice``.
233
* LaTeX: let rounded boxes support up to 4 distinct border-widths (refs: #11243)
234
* LaTeX: new options ``noteTextColor``, ``noteTeXextras`` et al.
235
See :ref:`additionalcss`.
236
* LaTeX: support elliptical corners in rounded boxes. (refs: #11254)
237
* #11150: Include source location in highlighting warnings, when lexing fails.
238
Patch by Jeremy Maitin-Shepard
239
* #11281: Support for :confval:`imgmath_latex` ``= 'tectonic'`` or
240
``= 'xelatex'``. Patch by Dimitar Dimitrov
241
* #11109, #9643: Add :confval:`python_display_short_literal_types` option for
242
condensed rendering of ``Literal`` types.
243
* #11079: LaTeX: figures with align attribute may disappear and strangely impact
244
following lists
245
* #11093: LaTeX: fix "multiply-defined references" PDF build warnings when one or
246
more reST labels directly precede an :rst:dir:`py:module` or :rst:dir:`automodule`
247
directive. Patch by Bénédikt Tran (picnixz)
248
* #11110: LaTeX: Figures go missing from latex pdf if their files have the same
249
base name and they use a post transform. Patch by aaron-cooper
250
* LaTeX: fix potential color leak from shadow to border of rounded boxes, if
251
shadow color is set but border color is not
252
* LaTeX: fix unintended 1pt upwards vertical shift of code blocks frames
253
respective to contents (when using rounded corners)
254
* #11235: LaTeX: added ``\color`` in topic (or admonition) contents may cause color
255
leak to the shadow and border at a page break
256
* #11264: LaTeX: missing space before colon after "Voir aussi" for :rst:dir:`seealso`
257
directive in French
258
* #11268: LaTeX: longtable with left alignment breaks out of current list
259
indentation context in PDF. Thanks to picnixz.
260
* #11274: LaTeX: external links are not properly escaped for ``\sphinxupquote``
261
compatibility
262
* #11147: Fix source file/line number info in object description content and in
263
other uses of ``nested_parse_with_titles``. Patch by Jeremy Maitin-Shepard.
264
* #11192: Restore correct parallel search index building.
265
Patch by Jeremy Maitin-Shepard
266
* Use the new Transifex ``tx`` client
267
* Fail testing when any Python warnings are emitted
268
* Migrate remaining ``unittest.TestCase`` style test functions to pytest style
269
* Remove tests that rely on setuptools
270
- Remove alabaster-0713-compat.patch upstreamed patch.
271
- Update intersphinx links.
272
- Install filelock python dependency for tests.
273
- Run tests parallel.
274
275
-------------------------------------------------------------------
276
Fri Apr 21 12:21:22 UTC 2023 - Dirk Müller <dmueller@suse.com>
277
278
- add sle15_python_module_pythons (jsc#PED-68)
279
280
-------------------------------------------------------------------
281
Thu Apr 13 22:45:03 UTC 2023 - Matej Cepl <mcepl@suse.com>
282
283
- Make calling of %{sle15modernpython} optional.
284
285
-------------------------------------------------------------------
286
Sun Jan 29 18:59:21 UTC 2023 - Dirk Müller <dmueller@suse.com>
287
288
- add alabaster-0713-compat.patch to fix testsuite failure with
289
newer alabaster theme.
290
291
-------------------------------------------------------------------
292
Tue Jan 10 18:02:04 UTC 2023 - Martin Liška <mliska@suse.cz>
293
294
- Update to version 6.1.3
295
* #11116: Reverted to previous Sphinx 5 node copying method
296
* #11117: Reverted changes to parallel image processing from Sphinx 6.1.0
297
* #11119: Supress ``ValueError`` in the ``linkcheck`` builder
298
299
-------------------------------------------------------------------
300
Sun Jan 8 09:18:41 UTC 2023 - Martin Liška <mliska@suse.cz>
301
302
- Update to version 6.1.2
303
* #11101: LaTeX: div.topic_padding key of sphinxsetup documented at 5.1.0 was
304
implemented with name topic_padding
305
* #11099: LaTeX: shadowrule key of sphinxsetup causes PDF build to crash since
306
Sphinx 5.1.0
307
* #11096: LaTeX: shadowsize key of sphinxsetup causes PDF build to crash since
308
Sphinx 5.1.0
309
* #11095: LaTeX: shadow of topic and contents boxes not in page margin since
310
Sphinx 5.1.0
311
* #11100: Fix copying images when running under parallel mode.
312
- Disable test_copy_images tests as they need an internet access.
313
314
-------------------------------------------------------------------
315
Thu Jan 5 18:09:36 UTC 2023 - Martin Liška <mliska@suse.cz>
316
317
- Update to version 6.1.1
318
* #11091: Fix ``util.nodes.apply_source_workaround`` for ``literal_block`` nodes
319
with no source information in the node or the node's parents.
320
* Adopted the `Ruff`_ code linter.
321
.. _Ruff: https://github.com/charliermarsh/ruff
322
* #10979: gettext: Removed support for pluralisation in ``get_translation``.
323
This was unused and complicated other changes to ``sphinx.locale``.
324
* ``sphinx.util`` functions:
325
* Renamed ``sphinx.util.typing.stringify()``
326
to ``sphinx.util.typing.stringify_annotation()``
327
* Moved ``sphinx.util.xmlname_checker()``
328
to ``sphinx.builders.epub3._XML_NAME_PATTERN``
329
330
Moved to ``sphinx.util.display``:
331
332
* ``sphinx.util.status_iterator``
333
* ``sphinx.util.display_chunk``
334
* ``sphinx.util.SkipProgressMessage``
335
* ``sphinx.util.progress_message``
336
337
Moved to ``sphinx.util.http_date``:
338
339
* ``sphinx.util.epoch_to_rfc1123``
340
* ``sphinx.util.rfc1123_to_epoch``
341
342
Moved to ``sphinx.util.exceptions``:
343
344
* ``sphinx.util.save_traceback``
345
* ``sphinx.util.format_exception_cut_frames``
346
347
* Cache doctrees in the build environment during the writing phase.
348
* Make all writing phase tasks support parallel execution.
349
* #11072: Use PEP 604 (``X | Y``) display conventions for ``typing.Optional``
350
and ``typing.Optional`` types within the Python domain and autodoc.
351
* #10700: autodoc: Document ``typing.NewType()`` types as classes rather than
352
'data'.
353
* Cache doctrees between the reading and writing phases.
354
* #10962: HTML: Fix the multi-word key name lookup table.
355
* Fixed support for Python 3.12 alpha 3 (changes in the ``enum`` module).
356
* #11069: HTML Theme: Removed outdated "shortcut" link relation keyword.
357
* #10952: Properly terminate parallel processes on programme interuption.
358
* #10988: Speed up ``TocTree.resolve()`` through more efficient copying.
359
* #6744: LaTeX: support for seealso directive should be via an environment
360
to allow styling.
361
* #11074: LaTeX: Can't change sphinxnote to use sphinxheavybox starting with
362
5.1.0
363
* Require Pygments 2.13 or later.
364
* #10944: imgmath: Fix resolving image paths for files in nested folders.
365
366
-------------------------------------------------------------------
367
Wed Jan 4 05:56:10 UTC 2023 - Martin Liška <mliska@suse.cz>
368
369
- Add pygments-2.14.patch in order to fix Pygments tests
370
after the 2.14 release.
371
gh#sphinx-doc/sphinx#11067
372
373
-------------------------------------------------------------------
374
Sat Dec 31 09:06:47 UTC 2022 - Martin Liška <mliska@suse.cz>
375
376
- Update to version 6.0.0
377
* #10468: Drop Python 3.6 support
378
* #10470: Drop Python 3.7, Docutils 0.14, Docutils 0.15, Docutils 0.16, and
379
Docutils 0.17 support. Patch by Adam Turner
380
* #7405: Removed the jQuery and underscore.js JavaScript frameworks.
381
These frameworks are no longer be automatically injected into themes from
382
Sphinx 6.0. If you develop a theme or extension that uses the
383
``jQuery``, ``$``, or ``$u`` global objects, you need to update your
384
JavaScript to modern standards, or use the mitigation below.
385
The first option is to use the sphinxcontrib.jquery_ extension, which has been
386
developed by the Sphinx team and contributors. To use this, add
387
``sphinxcontrib.jquery`` to the ``extensions`` list in ``conf.py``, or call
388
``app.setup_extension("sphinxcontrib.jquery")`` if you develop a Sphinx theme
389
or extension.
390
The second option is to manually ensure that the frameworks are present.
391
To re-add jQuery and underscore.js, you will need to copy ``jquery.js`` and
392
``underscore.js`` from `the Sphinx repository`_ to your ``static`` directory,
393
and add the following to your ``layout.html``:
394
395
.. code-block:: html+jinja
396
397
{%- block scripts %}
398
<script src="{{ pathto('_static/jquery.js', resource=True) }}"></script>
399
<script src="{{ pathto('_static/underscore.js', resource=True) }}"></script>
400
{{ super() }}
401
{%- endblock %}
402
403
.. _sphinxcontrib.jquery: https://github.com/sphinx-contrib/jquery/
404
Patch by Adam Turner.
405
* #10471, #10565: Removed deprecated APIs scheduled for removal in Sphinx 6.0. See
406
:ref:`dev-deprecated-apis` for details. Patch by Adam Turner.
407
* #10901: C Domain: Remove support for parsing pre-v3 style type directives and
408
roles. Also remove associated configuration variables ``c_allow_pre_v3`` and
409
``c_warn_on_allowed_pre_v3``. Patch by Adam Turner.
410
* #10924: LaTeX: adopt better looking defaults for tables and code-blocks.
411
See :confval:`latex_table_style` and the ``pre_border-radius`` and
412
``pre_background-TeXcolor`` :ref:`additionalcss` for the former defaults
413
and how to re-enact them if desired.
414
* #10984: LaTeX: Document :confval:`latex_additional_files` behavior for files
415
with ``.tex`` extension.
416
417
-------------------------------------------------------------------
418
Sun Oct 16 14:43:01 UTC 2022 - Martin Liška <mliska@suse.cz>
419
420
- Update to version 5.3.0
421
* #10759: LaTeX: add :confval:`latex_table_style` and support the
422
``'booktabs'``, ``'borderless'``, and ``'colorrows'`` styles.
423
(thanks to Stefan Wiehler for initial pull requests #6666, #6671)
424
* #10840: One can cross-reference including an option value like ``:option:`--module=foobar```,
425
``:option:`--module[=foobar]``` or ``:option:`--module foobar```.
426
Patch by Martin Liska.
427
* #10881: autosectionlabel: Record the generated section label to the debug log.
428
* #10268: Correctly URI-escape image filenames.
429
* #10887: domains: Allow sections in all the content of all object description
430
directives (e.g. :rst:dir:`py:function`). Patch by Adam Turner
431
432
-------------------------------------------------------------------
433
Sun Oct 2 18:47:20 UTC 2022 - Markéta Machová <mmachova@suse.com>
434
435
- BuildRequires just flit-core instead of flit
436
437
-------------------------------------------------------------------
438
Fri Sep 30 18:06:55 UTC 2022 - Martin Liška <mliska@suse.cz>
439
440
- Update to version 5.2.3
441
* #10878: Fix base64 image embedding in sphinx.ext.imgmath
442
* #10886: Add :nocontentsentry: flag and global domain table of contents entry
443
control option. Patch by Adam Turner
444
445
-------------------------------------------------------------------
446
Tue Sep 27 15:35:11 UTC 2022 - Martin Liška <mliska@suse.cz>
447
448
- Update to version 5.2.2
449
* #10872: Restore link targets for autodoc modules to the top of content.
450
Patch by Dominic Davis-Foster.
451
452
-------------------------------------------------------------------
453
Mon Sep 26 07:06:34 UTC 2022 - Martin Liška <mliska@suse.cz>
454
455
- Update to version 5.2.1
456
* #10861: Always normalise the ``pycon3`` lexer to ``pycon``.
457
* Fix using ``sphinx.ext.autosummary`` with modules containing titles in the
458
module-level docstring.
459
- Remove unneeded spec hunks.
460
461
-------------------------------------------------------------------
462
Sun Sep 25 15:24:42 UTC 2022 - Martin Liška <mliska@suse.cz>
463
464
- Update to version 5.2.0
465
* #10356: Sphinx now uses declarative metadata with pyproject.toml to create packages,
466
using PyPA’s build project as a build backend. Patch by Adam Turner.
467
* #10286: C++, support requires clauses not just between the template parameter lists and the declaration.
468
* #10755: linkcheck: Check the source URL of raw directives that use the url option.
469
* #10781: Allow ref role to be used with definitions and fields.
470
* #10717: HTML Search: Increase priority for full title and subtitle matches in search results
471
* #10718: HTML Search: Save search result score to the HTML element for debugging
472
* #10673: Make toctree accept ‘genindex’, ‘modindex’ and ‘search’ docnames
473
* #6316, #10804: Add domain objects to the table of contents. Patch by Adam Turner
474
* #6692: HTML Search: Include explicit index directive index entries in the search index and search results. Patch by Adam Turner
475
* #10816: imgmath: Allow embedding images in HTML as base64
476
* #10257: C++, ensure consistent non-specialization template argument representation.
477
* #10729: C++, fix parsing of certain non-type template parameter packs.
478
* #10715: Revert #10520: “Fix” use of sidebar classes in agogo.css_t
479
480
-------------------------------------------------------------------
481
Wed Jul 27 06:58:04 UTC 2022 - Martin Liška <mliska@suse.cz>
482
483
- Update to version 5.1.1
484
* #10701: Fix ValueError in the new ``deque`` based ``sphinx.ext.napolean``
485
iterator implementation.
486
* #10702: Restore compatability with third-party builders.
487
488
-------------------------------------------------------------------
489
Sun Jul 24 17:44:29 UTC 2022 - Martin Liška <mliska@suse.cz>
490
491
- Update to version 5.1.0
492
* #10656: Support `Docutils 0.19`_. Patch by Adam Turner.
493
* #10467: Deprecated ``sphinx.util.stemmer`` in favour of ``snowballstemmer``.
494
Patch by Adam Turner.
495
* #9856: Deprecated ``sphinx.ext.napoleon.iterators``.
496
* #10444: html theme: Allow specifying multiple CSS files through the ``stylesheet``
497
setting in ``theme.conf`` or by setting ``html_style`` to an iterable of strings.
498
* #10366: std domain: Add support for emphasising placeholders in :rst:dir:`option`
499
directives through a new :confval:`option_emphasise_placeholders` configuration
500
option.
501
* #10439: std domain: Use the repr of some variables when displaying warnings,
502
making whitespace issues easier to identify.
503
* #10571: quickstart: Reduce content in the generated ``conf.py`` file. Patch by
504
Pradyun Gedam.
505
* #10648: LaTeX: CSS-named-alike additional :ref:`'sphinxsetup' <latexsphinxsetup>`
506
keys allow to configure four separate border-widths, four paddings, four
507
corner radii, a shadow (possibly inset), colours for border, background, shadow
508
for each of the code-block, topic, attention, caution, danger, error and warning
509
directives.
510
* #10655: LaTeX: Explain non-standard encoding in LatinRules.xdy
511
* #10599: HTML Theme: Wrap consecutive footnotes in an ``<aside>`` element when
512
using Docutils 0.18 or later, to allow for easier styling. This matches the
513
behaviour introduced in Docutils 0.19. Patch by Adam Turner.
514
* #10518: config: Add ``include_patterns`` as the opposite of ``exclude_patterns``.
515
Patch by Adam Turner.
516
* #10594: HTML Theme: field term colons are doubled if using Docutils 0.18+
517
* #10596: Build failure if Docutils version is 0.18 (not 0.18.1) due
518
to missing ``Node.findall()``
519
* #10506: LaTeX: build error if highlighting inline code role in figure caption
520
(refs: #10251)
521
* #10634: Make -P (pdb) option work better with exceptions triggered from events
522
* #10031: py domain: Fix spurious whitespace in unparsing various operators (``+``,
523
``-``, ``~``, and ``**``). Patch by Adam Turner.
524
* #10460: logging: Always show node source locations as absolute paths.
525
* HTML Search: HTML tags are displayed as a part of object name
526
* HTML Search: search snipets should not be folded
527
* HTML Search: Minor errors are emitted on fetching search snipets
528
* HTML Search: The markers for header links are shown in the search result
529
* #10520: HTML Theme: Fix use of sidebar classes in ``agogo.css_t``.
530
* #6679: HTML Theme: Fix inclusion of hidden toctrees in the agogo theme.
531
* #10566: HTML Theme: Fix enable_search_shortcuts does not work
532
* #8686: LaTeX: Text can fall out of code-block at end of page and leave artifact
533
on next page
534
* #10633: LaTeX: user injected ``\color`` commands in topic or admonition boxes may
535
cause color leaks in PDF due to upstream `framed.sty <https://ctan.org/pkg/framed>`_
536
bug
537
* #10638: LaTeX: framed coloured boxes in highlighted code (e.g. highlighted
538
diffs using Pygments style ``'manni'``) inherit thickness of code-block frame
539
* #10647: LaTeX: Only one ``\label`` is generated for ``desc_signature`` node
540
even if it has multiple node IDs
541
* #10579: i18n: UnboundLocalError is raised on translating raw directive
542
* #9577, #10088: py domain: Fix warning for duplicate Python references when
543
using ``:any:`` and autodoc.
544
* #10548: HTML Search: fix minor summary issues.
545
- Add update-intersphinx.sh and get all objects.inv files.
546
- Add Adam Turner's GPG key (61F0FB52) to python-Sphinx.keyring.
547
548
-------------------------------------------------------------------
549
Tue Jul 19 18:05:49 UTC 2022 - Matej Cepl <mcepl@suse.com>
550
551
- (bsc#1201272) Add a missing dependency of latex subpackage on
552
tex(tgtermes.sty).
553
- Add python-Sphinx.keyring
554
555
-------------------------------------------------------------------
556
Fri Jun 17 14:09:37 UTC 2022 - Martin Liška <mliska@suse.cz>
557
558
- Update to version 5.0.2
559
* #10523: HTML Theme: Expose the Docutils's version info tuple as a template
560
variable, ``docutils_version_info``. Patch by Adam Turner.
561
* #10538: autodoc: Inherited class attribute having docstring is documented even
562
if :confval:`autodoc_inherit_docstring` is disabled
563
* #10509: autosummary: autosummary fails with a shared library
564
* #10497: py domain: Failed to resolve strings in Literal. Patch by Adam Turner.
565
* #10523: HTML Theme: Fix double brackets on citation references in Docutils 0.18+.
566
Patch by Adam Turner.
567
* #10534: Missing CSS for nav.contents in Docutils 0.18+. Patch by Adam Turner.
568
569
-------------------------------------------------------------------
570
Fri Jun 3 08:12:27 UTC 2022 - Michael Ströder <michael@stroeder.com>
571
572
- Update to version 5.0.1
573
* #10498: gettext: TypeError is raised when sorting warning messages if a node
574
has no line number
575
* #10493: html theme: :rst:dir:`topic` directive is rendered incorrectly with
576
docutils-0.18
577
* #10495: IndexError is raised for a :rst:role:`kbd` role having a separator
578
579
-------------------------------------------------------------------
580
Mon May 30 09:20:27 UTC 2022 - Martin Liška <mliska@suse.cz>
581
582
- Update to version 5.0.0:
583
584
* #10164: Support `Docutils 0.18`_. Patch by Adam Turner.
585
* #10031: autosummary: ``sphinx.ext.autosummary.import_by_name()`` now raises
586
``ImportExceptionGroup`` instead of ``ImportError`` when it failed to import
587
target object. Please handle the exception if your extension uses the
588
function to import Python object. As a workaround, you can disable the
589
behavior via ``grouped_exception=False`` keyword argument until v7.0.
590
* #9962: texinfo: Customizing styles of emphasized text via ``@definfoenclose``
591
command was not supported because the command was deprecated since texinfo 6.8
592
* #2068: :confval:`intersphinx_disabled_reftypes` has changed default value
593
from an empty list to ``['std:doc']`` as avoid too surprising silent
594
intersphinx resolutions.
595
To migrate: either add an explicit inventory name to the references
596
intersphinx should resolve, or explicitly set the value of this configuration
597
variable to an empty list.
598
* #10197: html theme: Reduce ``body_min_width`` setting in basic theme to 360px
599
* #9999: LaTeX: separate terms from their definitions by a CR (refs: #9985)
600
* #10062: Change the default language to ``'en'`` if any language is not set in
601
``conf.py``
602
* #10474: :confval:`language` does not accept ``None`` as it value. The default
603
value of ``language`` becomes to ``'en'`` now.
604
* #10028: jQuery and underscore.js will no longer be automatically injected into
605
themes from Sphinx 6.0. If you develop a theme or extension that uses the
606
``jQuery``, ``$``, or ``$u`` global objects, you need to update your
607
JavaScript or use the mitigation below.
608
609
To re-add jQuery and underscore.js, you will need to copy ``jquery.js`` and
610
``underscore.js`` from `the Sphinx repository`_ to your ``static`` directory,
611
and add the following to your ``layout.html``:
612
613
.. _the Sphinx repository: https://github.com/sphinx-doc/sphinx/tree/v4.3.2/sphinx/themes/basic/static
614
.. code-block:: html+jinja
615
616
{%- block scripts %}
617
<script src="{{ pathto('_static/jquery.js', resource=True) }}"></script>
618
<script src="{{ pathto('_static/underscore.js', resource=True) }}"></script>
619
{{ super() }}
620
{%- endblock %}
621
* setuptools integration. The ``build_sphinx`` sub-command for setup.py is
622
marked as deprecated to follow the policy of setuptools team.
623
* The ``locale`` argument of ``sphinx.util.i18n:babel_format_date()`` becomes
624
required
625
* The ``language`` argument of ``sphinx.util.i18n:format_date()`` becomes
626
required
627
* ``sphinx.builders.html.html5_ready``
628
* ``sphinx.io.read_doc()``
629
* ``sphinx.util.docutils.__version_info__``
630
* ``sphinx.util.docutils.is_html5_writer_available()``
631
* ``sphinx.writers.latex.LaTeXWriter.docclasses``
632
* #9075: autodoc: The default value of :confval:`autodoc_typehints_format` is
633
changed to ``'smart'``. It will suppress the leading module names of
634
typehints (ex. ``io.StringIO`` -> ``StringIO``).
635
* #8417: autodoc: ``:inherited-members:`` option now takes multiple classes. It
636
allows to suppress inherited members of several classes on the module at once
637
by specifying the option to :rst:dir:`automodule` directive
638
* #9792: autodoc: Add new option for ``autodoc_typehints_description_target`` to
639
include undocumented return values but not undocumented parameters.
640
* #10285: autodoc: singledispatch functions having typehints are not documented
641
* autodoc: :confval:`autodoc_typehints_format` now also applies to attributes,
642
data, properties, and type variable bounds.
643
* #10258: autosummary: Recognize a documented attribute of a module as
644
non-imported
645
* #10028: Removed internal usages of JavaScript frameworks (jQuery and
646
underscore.js) and modernised ``doctools.js`` and ``searchtools.js`` to
647
EMCAScript 2018.
648
* #10302: C++, add support for conditional expressions (``?:``).
649
* #5157, #10251: Inline code is able to be highlighted via :rst:dir:`role`
650
directive
651
* #10337: Make sphinx-build faster by caching Publisher object during build
652
* #10200: apidoc: Duplicated submodules are shown for modules having both .pyx
653
and .so files
654
* #10279: autodoc: Default values for keyword only arguments in overloaded
655
functions are rendered as a string literal
656
* #10280: autodoc: :confval:`autodoc_docstring_signature` unexpectedly generates
657
return value typehint for constructors if docstring has multiple signatures
658
* #10266: autodoc: :confval:`autodoc_preserve_defaults` does not work for
659
mixture of keyword only arguments with/without defaults
660
* #10310: autodoc: class methods are not documented when decorated with mocked
661
function
662
* #10305: autodoc: Failed to extract optional forward-ref'ed typehints correctly
663
via :confval:`autodoc_type_aliases`
664
* #10421: autodoc: :confval:`autodoc_preserve_defaults` doesn't work on class
665
methods
666
* #10214: html: invalid language tag was generated if :confval:`language`
667
contains a country code (ex. zh_CN)
668
* #9974: html: Updated jQuery version from 3.5.1 to 3.6.0
669
* #10236: html search: objects are duplicated in search result
670
* #9962: texinfo: Deprecation message for ``@definfoenclose`` command on
671
bulding texinfo document
672
* #10000: LaTeX: glossary terms with common definition are rendered with
673
too much vertical whitespace
674
* #10188: LaTeX: alternating multiply referred footnotes produce a ``?`` in
675
pdf output
676
* #10363: LaTeX: make ``'howto'`` title page rule use ``\linewidth`` for
677
compatibility with usage of a ``twocolumn`` class option
678
* #10318: ``:prepend:`` option of :rst:dir:`literalinclude` directive does not
679
work with ``:dedent:`` option
680
* #9575: autodoc: The annotation of return value should not be shown when
681
``autodoc_typehints="description"``
682
* #9648: autodoc: ``*args`` and ``**kwargs`` entries are duplicated when
683
``autodoc_typehints="description"``
684
* #8180: autodoc: Docstring metadata ignored for attributes
685
* #10443: epub: EPUB builder can't detect the mimetype of .webp file
686
* #10104: gettext: Duplicated locations are shown if 3rd party extension does
687
not provide correct information
688
* #10456: py domain: ``:meta:`` fields are displayed if docstring contains two
689
or more meta-field
690
* #9096: sphinx-build: the value of progress bar for paralle build is wrong
691
* #10110: sphinx-build: exit code is not changed when error is raised on
692
builder-finished event
693
694
-------------------------------------------------------------------
695
Mon Mar 28 08:29:11 UTC 2022 - Martin Liška <mliska@suse.cz>
696
697
- Update to version 4.5.0:
698
* #10112: extlinks: Disable hardcoded links detector by default
699
* #9993, #10177: std domain: Disallow to refer an inline target via
700
:rst:role:`ref` role
701
* ``sphinx.ext.napoleon.docstring.GoogleDocstring._qualify_name()``
702
* #10260: Enable ``FORCE_COLOR`` and ``NO_COLOR`` for terminal colouring
703
* #10234: autosummary: Add "autosummary" CSS class to summary tables
704
* #10125: extlinks: Improve suggestion message for a reference having title
705
* #10112: extlinks: Add :confval:`extlinks_detect_hardcoded_links` to enable
706
hardcoded links detector feature
707
* #9494, #9456: html search: Add a config variable
708
:confval:`html_show_search_summary` to enable/disable the search summaries
709
* #9337: HTML theme, add option ``enable_search_shortcuts`` that enables :kbd:'/' as
710
a Quick search shortcut and :kbd:`Esc` shortcut that
711
removes search highlighting.
712
* #10107: i18n: Allow to suppress translation warnings by adding ``#noqa``
713
comment to the tail of each translation message
714
* #10252: C++, support attributes on classes, unions, and enums.
715
* #10253: :rst:dir:`pep` role now generates URLs based on peps.python.org
716
* #9876: autodoc: Failed to document an imported class that is built from native
717
binary module
718
* #10133: autodoc: Crashed when mocked module is used for type annotation
719
* #10146: autodoc: :confval:`autodoc_default_options` does not support
720
``no-value`` option
721
* #9971: autodoc: TypeError is raised when the target object is annotated by
722
unhashable object
723
* #10205: extlinks: Failed to compile regexp on checking hardcoded links
724
* #10277: html search: Could not search short words (ex. "use")
725
* #9529: LaTeX: named auto numbered footnote (ex. ``[#named]``) that is referred
726
multiple times was rendered to a question mark
727
* #9924: LaTeX: multi-line :rst:dir:`cpp:function` directive has big vertical
728
spacing in Latexpdf
729
* #10158: LaTeX: excessive whitespace since v4.4.0 for undocumented
730
variables/structure members
731
* #10175: LaTeX: named footnote reference is linked to an incorrect footnote if
732
the name is also used in the different document
733
* #10269: manpage: Failed to resolve the title of :ref: cross references
734
* #10179: i18n: suppress "rST localization" warning
735
* #10118: imgconverter: Unnecessary availablity check is called for remote URIs
736
* #10181: napoleon: attributes are displayed like class attributes for google
737
style docstrings when :confval:`napoleon_use_ivar` is enabled
738
* #10122: sphinx-build: make.bat does not check the installation of sphinx-build
739
command before showing help
740
- Update url for requests.inv.
741
742
-------------------------------------------------------------------
743
Fri Jan 28 11:01:23 UTC 2022 - Matej Cepl <mcepl@suse.com>
744
745
- SPEC cleanup
746
747
-------------------------------------------------------------------
748
Thu Jan 20 14:26:44 UTC 2022 - Ben Greiner <code@bnavigator.de>
749
750
- Fix missing install_requires dependencies.
751
752
-------------------------------------------------------------------
753
Wed Jan 19 16:49:53 UTC 2022 - Matej Cepl <mcepl@suse.com>
754
755
- I know it looks cool to have URLs for all Source files, but these are
756
files in VCS and they are inherently very unstable, so it breaks our
757
checks.
758
759
-------------------------------------------------------------------
760
Sun Jan 16 18:25:51 UTC 2022 - Martin Liška <mliska@suse.cz>
761
762
- Update to version 4.4.0:
763
* #10007: Use ``importlib_metadata`` for python-3.9 or older
764
* #10007: Drop ``setuptools``
765
* #9075: autodoc: Add a config variable :confval:`autodoc_typehints_format`
766
to suppress the leading module names of typehints of function signatures (ex.
767
``io.StringIO`` -> ``StringIO``)
768
* #9831: Autosummary now documents only the members specified in a module's
769
``__all__`` attribute if :confval:`autosummary_ignore_module_all` is set to
770
``False``. The default behaviour is unchanged. Autogen also now supports
771
this behavior with the ``--respect-module-all`` switch.
772
* #9555: autosummary: Improve error messages on failure to load target object
773
* #9800: extlinks: Emit warning if a hardcoded link is replaceable
774
by an extlink, suggesting a replacement.
775
* #9961: html: Support nested <kbd> HTML elements in other HTML builders
776
* #10013: html: Allow to change the loading method of JS via ``loading_method``
777
parameter for :meth:`Sphinx.add_js_file()`
778
* #9551: html search: "Hide Search Matches" link removes "highlight" parameter
779
from URL
780
* #9815: html theme: Wrap sidebar components in div to allow customizing their
781
layout via CSS
782
* #9827: i18n: Sort items in glossary by translated terms
783
* #9899: py domain: Allows to specify cross-reference specifier (``.`` and
784
``~``) as ``:type:`` option
785
* #9894: linkcheck: add option ``linkcheck_exclude_documents`` to disable link
786
checking in matched documents.
787
* #9793: sphinx-build: Allow to use the parallel build feature in macOS on macOS
788
and Python3.8+
789
* #10055: sphinx-build: Create directories when ``-w`` option given
790
* #9993: std domain: Allow to refer an inline target (ex. ``_`target name```)
791
via :rst:role:`ref` role
792
* #9981: std domain: Strip value part of the option directive from general index
793
* #9391: texinfo: improve variable in ``samp`` role
794
* #9578: texinfo: Add :confval:`texinfo_cross_references` to disable cross
795
references for readability with standalone readers
796
* #9822 (and #9062), add new Intersphinx role :rst:role:`external` for explict
797
lookup in the external projects, without resolving to the local project.
798
* #9866: autodoc: doccomment for the imported class was ignored
799
* #9883: autodoc: doccomment for the alias to mocked object was ignored
800
* #9908: autodoc: debug message is shown on building document using NewTypes
801
with Python 3.10
802
* #9968: autodoc: instance variables are not shown if __init__ method has
803
position-only-arguments
804
* #9194: autodoc: types under the "typing" module are not hyperlinked
805
* #10009: autodoc: Crashes if target object raises an error on getting docstring
806
* #10058: autosummary: Imported members are not shown when
807
``autodoc_class_signature = 'separated'``
808
* #9947: i18n: topic directive having a bullet list can't be translatable
809
* #9878: mathjax: MathJax configuration is placed after loading MathJax itself
810
* #9932: napoleon: empty "returns" section is generated even if no description
811
* #9857: Generated RFC links use outdated base url
812
* #9909: HTML, prevent line-wrapping in literal text.
813
* #10061: html theme: Configuration values added by themes are not be able to
814
override from conf.py
815
* #10073: imgconverter: Unnecessary availablity check is called for "data" URIs
816
* #9925: LaTeX: prohibit also with ``'xelatex'`` line splitting at dashes of
817
inline and parsed literals
818
* #9944: LaTeX: extra vertical whitespace for some nested declarations
819
* #9940: LaTeX: Multi-function declaration in Python domain has cramped
820
vertical spacing in latexpdf output
821
* #10015: py domain: types under the "typing" module are not hyperlinked defined
822
at info-field-list
823
* #9390: texinfo: Do not emit labels inside footnotes
824
* #9413: xml: Invalid XML was generated when cross referencing python objects
825
* #9979: Error level messages were displayed as warning messages
826
* #10057: Failed to scan documents if the project is placed onto the root
827
directory
828
* #9636: code-block: ``:dedent:`` without argument did strip newlines
829
- Add new intersphinx mapping file: readthedocs.inv.
830
- Fix %fdupes.
831
- Remove python-Sphinx-rpmlintrc as it is not used any more.
832
833
-------------------------------------------------------------------
834
Wed Dec 22 10:11:19 UTC 2021 - Martin Liška <mliska@suse.cz>
835
836
- Update to version 4.3.2:
837
* #9917: C and C++, parse fundamental types no matter the order of simple type
838
specifiers.
839
840
-------------------------------------------------------------------
841
Sat Nov 27 21:14:22 UTC 2021 - Arun Persaud <arun@gmx.de>
842
843
- update to version 4.3.1:
844
* Features added
845
+ #9864: mathjax: Support chnaging the loading method of MathJax
846
to "defer" via :confval:`mathjax_options`
847
* Bugs fixed
848
+ #9838: autodoc: AttributeError is raised on building document
849
for functions decorated by functools.lru_cache
850
+ #9879: autodoc: AttributeError is raised on building document
851
for an object having invalid __doc__ atribute
852
+ #9844: autodoc: Failed to process a function wrapped with
853
functools.partial if :confval:`autodoc_preserve_defaults`
854
enabled
855
+ #9872: html: Class namespace collision between autodoc
856
signatures and docutils-0.17
857
+ #9868: imgmath: Crashed if the dvisvgm command failed to convert
858
equation
859
+ #9864: mathjax: Failed to render equations via MathJax v2. The
860
loading method of MathJax is back to "async" method again
861
862
-------------------------------------------------------------------
863
Fri Nov 12 16:29:59 UTC 2021 - Matej Cepl <mcepl@suse.com>
864
865
- Explicitly Require python-sphinxcontrib-qthelp >= 1.0.2 to prevent
866
bsc#1157793 and bsc#1158158 from occuring.
867
868
-------------------------------------------------------------------
869
Fri Nov 12 11:45:06 UTC 2021 - Martin Liška <mliska@suse.cz>
870
871
- Update rpmlintrc file.
872
- Update to 4.3.0:
873
874
* Support Python 3.10
875
876
* #9649: ``searchindex.js``: the embedded data has changed format to allow
877
objects with the same name in different domains.
878
* #9672: The rendering of Python domain declarations is implemented
879
with more docutils nodes to allow better CSS styling.
880
It may break existing styling.
881
* #9672: the signature of
882
:py:meth:`domains.py.PyObject.get_signature_prefix` has changed to
883
return a list of nodes instead of a plain string.
884
* #9695: ``domains.js.JSObject.display_prefix`` has been changed into a method
885
``get_display_prefix`` which now returns a list of nodes
886
instead of a plain string.
887
* #9695: The rendering of Javascript domain declarations is implemented
888
with more docutils nodes to allow better CSS styling.
889
It may break existing styling.
890
* #9450: mathjax: Load MathJax via "defer" strategy
891
892
* ``sphinx.ext.autodoc.AttributeDocumenter._datadescriptor``
893
* ``sphinx.writers.html.HTMLTranslator._fieldlist_row_index``
894
* ``sphinx.writers.html.HTMLTranslator._table_row_index``
895
* ``sphinx.writers.html5.HTML5Translator._fieldlist_row_index``
896
* ``sphinx.writers.html5.HTML5Translator._table_row_index``
897
898
* #9639: autodoc: Support asynchronous generator functions
899
* #9664: autodoc: ``autodoc-process-bases`` supports to inject reST snippet as a
900
base class
901
* #9691: C, added new info-field ``retval``
902
for :rst:dir:`c:function` and :rst:dir:`c:macro`.
903
* C++, added new info-field ``retval`` for :rst:dir:`cpp:function`.
904
* #9618: i18n: Add :confval:`gettext_allow_fuzzy_translations` to allow "fuzzy"
905
messages for translation
906
* #9672: More CSS classes on Python domain descriptions
907
* #9695: More CSS classes on Javascript domain descriptions
908
* #9683: Revert the removal of ``add_stylesheet()`` API. It will be kept until
909
the Sphinx-6.0 release
910
* #2068, add :confval:`intersphinx_disabled_reftypes` for disabling
911
interphinx resolution of cross-references that do not have an explicit
912
inventory specification. Specific types of cross-references can be disabled,
913
e.g., ``std:doc`` or all cross-references in a specific domain,
914
e.g., ``std:*``.
915
* #9623: Allow to suppress "toctree contains reference to excluded document"
916
warnings using :confval:`suppress_warnings`
917
918
* #9630: autodoc: Failed to build cross references if :confval:`primary_domain`
919
is not 'py'
920
* #9644: autodoc: Crashed on getting source info from problematic object
921
* #9655: autodoc: mocked object having doc comment is warned unexpectedly
922
* #9651: autodoc: return type field is not generated even if
923
:confval:`autodoc_typehints_description_target` is set to "documented" when
924
its info-field-list contains ``:returns:`` field
925
* #9657: autodoc: The base class for a subclass of mocked object is incorrect
926
* #9607: autodoc: Incorrect base class detection for the subclasses of the
927
generic class
928
* #9755: autodoc: memory addresses are shown for aliases
929
* #9752: autodoc: Failed to detect type annotation for slots attribute
930
* #9756: autodoc: Crashed if classmethod does not have __func__ attribute
931
* #9757: autodoc: :confval:`autodoc_inherit_docstrings` does not effect to
932
overriden classmethods
933
* #9781: autodoc: :confval:`autodoc_preserve_defaults` does not support
934
hexadecimal numeric
935
* #9630: autosummary: Failed to build summary table if :confval:`primary_domain`
936
is not 'py'
937
* #9670: html: Fix download file with special characters
938
* #9710: html: Wrong styles for even/odd rows in nested tables
939
* #9763: html: parameter name and its type annotation are not separated in HTML
940
* #9649: HTML search: when objects have the same name but in different domains,
941
return all of them as result instead of just one.
942
* #7634: intersphinx: references on the file in sub directory are broken
943
* #9737: LaTeX: hlist is rendered as a list containing "aggedright" text
944
* #9678: linkcheck: file extension was shown twice in warnings
945
* #9697: py domain: An index entry with parens was registered for ``py:method``
946
directive with ``:property:`` option
947
* #9775: py domain: Literal typehint was converted to a cross reference when
948
:confval:`autodoc_typehints='description'`
949
* #9708: needs_extension failed to check double-digit version correctly
950
* #9688: Fix :rst:dir:`code`` does not recognize ``:class:`` option
951
* #9733: Fix for logging handler flushing warnings in the middle of the docs
952
build
953
* #9656: Fix warnings without subtype being incorrectly suppressed
954
* Intersphinx, for unresolved references with an explicit inventory,
955
e.g., ``proj:myFunc``, leave the inventory prefix in the unresolved text.
956
957
-------------------------------------------------------------------
958
Wed Nov 10 13:57:29 UTC 2021 - Matej Cepl <mcepl@suse.com>
959
960
- Fix Provides and Obsoletes ... we cannot use python_module there
961
962
-------------------------------------------------------------------
963
Tue Sep 14 09:13:14 UTC 2021 - Martin Liška <mliska@suse.cz>
964
965
- Update to 4.2.0:
966
* #9445: autodoc: Support class properties
967
* #9479: autodoc: Emit a warning if target is a mocked object
968
* #9560: autodoc: Allow to refer NewType instances with module name in Python
969
3.10 or above
970
* #9447: html theme: Expose the version of Sphinx in the form of tuple as a
971
template variable ``sphinx_version_tuple``
972
* #9594: manpage: Suppress the title of man page if description is empty
973
* #9445: py domain: ``:py:property:`` directive supports ``:classmethod:``
974
option to describe the class property
975
* #9524: test: SphinxTestApp can take ``builddir`` as an argument
976
* #9535: C and C++, support more fundamental types, including GNU extensions.
977
* #9608: apidoc: apidoc does not generate a module definition for implicit
978
namespace package
979
* #9504: autodoc: generate incorrect reference to the parent class if the target
980
class inherites the class having ``_name`` attribute
981
* #9537, #9589: autodoc: Some objects under ``typing`` module are not displayed
982
well with the HEAD of 3.10
983
* #9487: autodoc: typehint for cached_property is not shown
984
* #9509: autodoc: AttributeError is raised on failed resolving typehints
985
* #9518: autodoc: autodoc_docstring_signature does not effect to ``__init__()``
986
and ``__new__()``
987
* #9522: autodoc: PEP 585 style typehints having arguments (ex. ``list[int]``)
988
are not displayed well
989
* #9481: autosummary: some warnings contain non-existing filenames
990
* #9568: autosummary: summarise overlined sectioned headings correctly
991
* #9600: autosummary: Type annotations which contain commas in autosummary table
992
are not removed completely
993
* #9481: c domain: some warnings contain non-existing filenames
994
* #9481: cpp domain: some warnings contain non-existing filenames
995
* #9456: html search: abbreation marks are inserted to the search result if
996
failed to fetch the content of the page
997
* #9617: html search: The JS requirement warning is shown if browser is slow
998
* #9267: html theme: CSS and JS files added by theme were loaded twice
999
* #9585: py domain: ``:type:`` option for :rst:dir:`py:property` directive does
1000
not create a hyperlink
1001
* #9576: py domain: Literal typehint was converted to a cross reference
1002
* #9535 comment: C++, fix parsing of defaulted function parameters that are
1003
function pointers.
1004
* #9564: smartquotes: don't adjust typography for text with
1005
language-highlighted ``:code:`` role.
1006
* #9512: sphinx-build: crashed with the HEAD of Python 3.10
1007
1008
-------------------------------------------------------------------
1009
Sun Aug 1 09:22:28 UTC 2021 - Dirk Müller <dmueller@suse.com>
1010
1011
- update to 4.1.2:
1012
* linkcheck: Disable checking automatically generated anchors on
1013
github.com (ex. anchors in reST/Markdown documents)
1014
* autodoc: Custom types using ``typing.NewType`` are not displayed well
1015
with the HEAD of 3.10
1016
* autodoc: Some objects under ``typing`` module are not displayed well
1017
with the HEAD of 3.10
1018
* autodoc: crashed if ``autodoc_class_signature = "separated"``
1019
* html search: html_copy_source can't control the search summaries
1020
* linkcheck: Failed to check anchors in github.com
1021
1022
-------------------------------------------------------------------
1023
Sat Jul 17 13:23:38 UTC 2021 - Dirk Müller <dmueller@suse.com>
1024
1025
- update to 4.1.1:
1026
* sphinxcontrib-htmlhelp-2.0.0 or above
1027
* sphinxcontrib-serializinghtml-1.1.5 or above
1028
* html: HTML logo or Favicon specified as file not being found on output
1029
1030
-------------------------------------------------------------------
1031
Mon Jul 12 10:14:42 UTC 2021 - Martin Liška <mliska@suse.cz>
1032
1033
- Bump to 4.1.0:
1034
* Support jinja2-3.0
1035
* The ``app`` argument of ``sphinx.environment.BuildEnvironment`` becomes
1036
required
1037
* ``sphinx.application.Sphinx.html_theme``
1038
* ``sphinx.ext.autosummary._app``
1039
* ``sphinx.util.docstrings.extract_metadata()``
1040
* #8107: autodoc: Add ``class-doc-from`` option to :rst:dir:`autoclass`
1041
directive to control the content of the specific class like
1042
:confval:`autoclass_content`
1043
* #8588: autodoc: :confval:`autodoc_type_aliases` now supports dotted name. It
1044
allows you to define an alias for a class with module name like
1045
``foo.bar.BazClass``
1046
* #9175: autodoc: Special member is not documented in the module
1047
* #9195: autodoc: The arguments of ``typing.Literal`` are wrongly rendered
1048
* #9185: autodoc: :confval:`autodoc_typehints` allows ``'both'`` setting to
1049
allow typehints to be included both in the signature and description
1050
* #4257: autodoc: Add :confval:`autodoc_class_signature` to separate the class
1051
entry and the definition of ``__init__()`` method
1052
* #8061, #9218: autodoc: Support variable comment for alias classes
1053
* #3014: autodoc: Add :event:`autodoc-process-bases` to modify the base classes
1054
of the class definitions
1055
* #9272: autodoc: Render enum values for the default argument value better
1056
* #9384: autodoc: ``autodoc_typehints='none'`` now erases typehints for
1057
variables, attributes and properties
1058
* #3257: autosummary: Support instance attributes for classes
1059
* #9358: html: Add "heading" role to the toctree items
1060
* #9225: html: Add span tag to the return typehint of method/function
1061
* #9129: html search: Show search summaries when html_copy_source = False
1062
* #9307: html search: Prevent corrections and completions in search field
1063
* #9120: html theme: Eliminate prompt characters of code-block from copyable
1064
text
1065
* #9176: i18n: Emit a debug message if message catalog file not found under
1066
:confval:`locale_dirs`
1067
* #9414: LaTeX: Add xeCJKVerbAddon to default fvset config for Chinese documents
1068
* #9016: linkcheck: Support checking anchors on github.com
1069
* #9016: linkcheck: Add a new event :event:`linkcheck-process-uri` to modify
1070
URIs before checking hyperlinks
1071
* #6525: linkcheck: Add :confval:`linkcheck_allowed_redirects` to mark
1072
hyperlinks that are redirected to expected URLs as "working"
1073
* #1874: py domain: Support union types using ``|`` in info-field-list
1074
* #9268: py domain: :confval:`python_use_unqualified_type_names` supports type
1075
field in info-field-list
1076
* #9097: Optimize the parallel build
1077
* #9131: Add :confval:`nitpick_ignore_regex` to ignore nitpicky warnings using
1078
regular expressions
1079
* #9174: Add ``Sphinx.set_html_assets_policy`` to tell extensions to include
1080
HTML assets in all the pages. Extensions can check this via
1081
``Sphinx.registry.html_assets_policy``
1082
* C++, add support for
1083
- ``inline`` variables,
1084
- ``consteval`` functions,
1085
- ``constinit`` variables,
1086
- ``char8_t``,
1087
- ``explicit(<constant expression>)`` specifier,
1088
- digit separators in literals, and
1089
- constraints in placeholder type specifiers, aka. adjective syntax
1090
(e.g., ``Sortable auto &v``).
1091
* C, add support for digit separators in literals.
1092
* #9166: LaTeX: support containers in LaTeX output
1093
* #8872: autodoc: stacked singledispatches are wrongly rendered
1094
* #8597: autodoc: a docsting having metadata only should be treated as
1095
undocumented
1096
* #9185: autodoc: typehints for overloaded functions and methods are inaccurate
1097
* #9250: autodoc: The inherited method not having docstring is wrongly parsed
1098
* #9283: autodoc: autoattribute directive failed to generate document for an
1099
attribute not having any comment
1100
* #9364: autodoc: single element tuple on the default argument value is wrongly
1101
rendered
1102
* #9362: autodoc: AttributeError is raised on processing a subclass of Tuple[()]
1103
* #9404: autodoc: TypeError is raised on processing dict-like object (not a
1104
class) via autoclass directive
1105
* #9317: html: Pushing left key causes visiting the next page at the first page
1106
* #9381: html: URL for html_favicon and html_log does not work
1107
* #9270: html theme : pyramid theme generates incorrect logo links
1108
* #9217: manpage: The name of manpage directory that is generated by
1109
:confval:`man_make_section_directory` is not correct
1110
* #9350: manpage: Fix font isn't reset after keyword at the top of samp role
1111
* #9306: Linkcheck reports broken link when remote server closes the connection
1112
on HEAD request
1113
* #9280: py domain: "exceptions" module is not displayed
1114
* #9418: py domain: a Callable annotation with no parameters
1115
(e.g. ``Callable[[], None])`` will be rendered with a bracket missing
1116
(``Callable[], None]``)
1117
* #9319: quickstart: Make sphinx-quickstart exit when conf.py already exists
1118
* #9387: xml: XML Builder ignores custom visitors
1119
* #9224: ``:param:`` and ``:type:`` fields does not support a type containing
1120
whitespace (ex. ``Dict[str, str]``)
1121
* #8945: when transforming typed fields, call the specified role instead of
1122
making an single xref. For C and C++, use the ``expr`` role for typed fields.
1123
1124
-------------------------------------------------------------------
1125
Sat Jun 5 13:18:44 UTC 2021 - Martin Liška <mliska@suse.cz>
1126
1127
- Update again to 4.0.2.
1128
1129
-------------------------------------------------------------------
1130
Wed Jun 2 16:48:48 UTC 2021 - Matej Cepl <mcepl@suse.com>
1131
1132
- Switch off the failing test_signature_annotations. It is just
1133
not worthy filing upstream test on the obsolete version.
1134
1135
-------------------------------------------------------------------
1136
Wed Jun 2 13:53:05 UTC 2021 - Matej Cepl <mcepl@suse.com>
1137
1138
- Revert to 3.5.4
1139
1140
-------------------------------------------------------------------
1141
Fri May 21 09:18:07 UTC 2021 - Martin Liška <mliska@suse.cz>
1142
1143
- Update to 4.0.2: see upstream CHANGES.
1144
- Add texlive-tex-gyre build dependency for tests.
1145
1146
-------------------------------------------------------------------
1147
Fri Apr 16 07:02:35 UTC 2021 - Dirk Müller <dmueller@suse.com>
1148
1149
- update to 3.5.4:
1150
* #9071: Restrict docutils to 0.16
1151
* #9078: autodoc: Async staticmethods and classmethods are considered as non
1152
async coroutine-functions with Python3.10
1153
* #8870, #9001, #9051: html theme: The style are not applied with docutils-0.17
1154
1155
-------------------------------------------------------------------
1156
Tue Apr 6 01:32:14 UTC 2021 - Dirk Müller <dmueller@suse.com>
1157
1158
- update to 3.5.3:
1159
* #8959: using UNIX path separator in image directive confuses Sphinx on Windows
1160
1161
-------------------------------------------------------------------
1162
Tue Mar 16 10:32:34 UTC 2021 - Dirk Müller <dmueller@suse.com>
1163
1164
- update to 3.5.2:
1165
* #8943: i18n: Crashed by broken translation messages in ES, EL and HR
1166
* #8936: LaTeX: A custom LaTeX builder fails with unknown node error
1167
* #8952: Exceptions raised in a Directive cause parallel builds to hang
1168
* #8883: autodoc: AttributeError is raised on assigning __annotations__ on
1169
read-only class
1170
* #8884: html: minified js stemmers not included in the distributed package
1171
* #8885: html: AttributeError is raised if CSS/JS files are installed via
1172
:confval:`html_context`
1173
* #8880: viewcode: ExtensionError is raised on incremental build after
1174
unparsable python module found
1175
* LaTeX: ``multicol`` (it is anyhow a required part of the official latex2e
1176
base distribution)
1177
* Update Underscore.js to 1.12.0
1178
* #6550: html: The config variable ``html_add_permalinks`` is replaced by
1179
:confval:`html_permalinks` and :confval:`html_permalinks_icon`
1180
* pending_xref node for viewcode extension
1181
* ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.anchors_ignore``
1182
* ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.auth``
1183
* ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.broken``
1184
* ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.good``
1185
* ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.redirected``
1186
* ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.rqueue``
1187
* ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.to_ignore``
1188
* ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.workers``
1189
* ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.wqueue``
1190
* ``sphinx.builders.linkcheck.node_line_or_0()``
1191
* ``sphinx.ext.autodoc.AttributeDocumenter.isinstanceattribute()``
1192
* ``sphinx.ext.autodoc.directive.DocumenterBridge.reporter``
1193
* ``sphinx.ext.autodoc.importer.get_module_members()``
1194
* ``sphinx.ext.autosummary.generate._simple_info()``
1195
* ``sphinx.ext.autosummary.generate._simple_warn()``
1196
* ``sphinx.writers.html.HTMLTranslator.permalink_text``
1197
* ``sphinx.writers.html5.HTML5Translator.permalink_text``
1198
* #8022: autodoc: autodata and autoattribute directives does not show right-hand
1199
value of the variable if docstring contains ``:meta hide-value:`` in
1200
info-field-list
1201
* #8514: autodoc: Default values of overloaded functions are taken from actual
1202
implementation if they're ellipsis
1203
* #8775: autodoc: Support type union operator (PEP-604) in Python 3.10 or above
1204
* #8297: autodoc: Allow to extend :confval:`autodoc_default_options` via
1205
directive options
1206
* #8619: html: kbd role generates customizable HTML tags for compound keys
1207
* #8634: html: Allow to change the order of JS/CSS via ``priority`` parameter
1208
for :meth:`Sphinx.add_js_file()` and :meth:`Sphinx.add_css_file()`
1209
* #6241: html: Allow to add JS/CSS files to the specific page when an extension
1210
calls ``app.add_js_file()`` or ``app.add_css_file()`` on
1211
:event:`html-page-context` event
1212
* #6550: html: Allow to use HTML permalink texts via
1213
:confval:`html_permalinks_icon`
1214
* #1638: html: Add permalink icons to glossary terms
1215
* #8868: html search: performance issue with massive lists
1216
* #8867: html search: Update JavaScript stemmer code to the latest version of
1217
Snowball (v2.1.0)
1218
* #8852: i18n: Allow to translate heading syntax in MyST-Parser
1219
* #8649: imgconverter: Skip availability check if builder supports the image
1220
type
1221
* #8573: napoleon: Allow to change the style of custom sections using
1222
:confval:`napoleon_custom_styles`
1223
* #8004: napoleon: Type definitions in Google style docstrings are rendered as
1224
references when :confval:`napoleon_preprocess_types` enabled
1225
* #6241: mathjax: Include mathjax.js only on the document using equations
1226
* #8775: py domain: Support type union operator (PEP-604)
1227
* #8651: std domain: cross-reference for a rubric having inline item is broken
1228
* #7642: std domain: Optimize case-insensitive match of term
1229
* #8681: viewcode: Support incremental build
1230
* #8132: Add :confval:`project_copyright` as an alias of :confval:`copyright`
1231
* #207: Now :confval:`highlight_language` supports multiple languages
1232
* #2030: :rst:dir:`code-block` and :rst:dir:`literalinclude` supports automatic
1233
dedent via no-argument ``:dedent:`` option
1234
* C++, also hyperlink operator overloads in expressions and alias declarations.
1235
* #8247: Allow production lists to refer to tokens from other production groups
1236
* #8813: Show what extension (or module) caused it on errors on event handler
1237
* #8213: C++: add ``maxdepth`` option to :rst:dir:`cpp:alias` to insert nested
1238
declarations.
1239
* C, add ``noroot`` option to :rst:dir:`c:alias` to render only nested
1240
declarations.
1241
* C++, add ``noroot`` option to :rst:dir:`cpp:alias` to render only nested
1242
declarations.
1243
* #8727: apidoc: namespace module file is not generated if no submodules there
1244
* #741: autodoc: inherited-members doesn't work for instance attributes on super
1245
class
1246
* #8592: autodoc: ``:meta public:`` does not effect to variables
1247
* #8594: autodoc: empty __all__ attribute is ignored
1248
* #8315: autodoc: Failed to resolve struct.Struct type annotation
1249
* #8652: autodoc: All variable comments in the module are ignored if the module
1250
contains invalid type comments
1251
* #8693: autodoc: Default values for overloaded functions are rendered as string
1252
* #8134: autodoc: crashes when mocked decorator takes arguments
1253
* #8800: autodoc: Uninitialized attributes in superclass are recognized as
1254
undocumented
1255
* #8655: autodoc: Failed to generate document if target module contains an
1256
object that raises an exception on ``hasattr()``
1257
* #8306: autosummary: mocked modules are documented as empty page when using
1258
:recursive: option
1259
* #8232: graphviz: Image node is not rendered if graph file is in subdirectory
1260
* #8618: html: kbd role produces incorrect HTML when compound-key separators (-,
1261
+ or ^) are used as keystrokes
1262
* #8629: html: A type warning for html_use_opensearch is shown twice
1263
* #8714: html: kbd role with "Caps Lock" rendered incorrectly
1264
* #8123: html search: fix searching for terms containing + (Requires a custom
1265
search language that does not split on +)
1266
* #8665: html theme: Could not override globaltoc_maxdepth in theme.conf
1267
* #8446: html: consecutive spaces are displayed as single space
1268
* #8745: i18n: crashes with KeyError when translation message adds a new auto
1269
footnote reference
1270
* #4304: linkcheck: Fix race condition that could lead to checking the
1271
availability of the same URL twice
1272
* #8791: linkcheck: The docname for each hyperlink is not displayed
1273
* #7118: sphinx-quickstart: questionare got Mojibake if libreadline unavailable
1274
* #8094: texinfo: image files on the different directory with document are not
1275
copied
1276
* #8782: todo: Cross references in todolist get broken
1277
* #8720: viewcode: module pages are generated for epub on incremental build
1278
* #8704: viewcode: anchors are generated in incremental build after singlehtml
1279
* #8756: viewcode: highlighted code is generated even if not referenced
1280
* #8671: :confval:`highlight_options` is not working
1281
* #8341: C, fix intersphinx lookup types for names in declarations.
1282
* C, C++: in general fix intersphinx and role lookup types.
1283
* #8683: :confval:`html_last_updated_fmt` does not support UTC offset (%z)
1284
* #8683: :confval:`html_last_updated_fmt` generates wrong time zone for %Z
1285
* #1112: ``download`` role creates duplicated copies when relative path is
1286
specified
1287
* #2616 (fifth item): LaTeX: footnotes from captions are not clickable,
1288
and for manually numbered footnotes only first one with same number is
1289
an hyperlink
1290
* #7576: LaTeX with French babel and memoir crash: "Illegal parameter number
1291
in definition of ``\FNH@prefntext``"
1292
* #8055: LaTeX (docs): A potential display bug with the LaTeX generation step
1293
in Sphinx (how to generate one-column index)
1294
* #8072: LaTeX: Directive :rst:dir:`hlist` not implemented in LaTeX
1295
* #8214: LaTeX: The :rst:role:`index` role and the glossary generate duplicate
1296
entries in the LaTeX index (if both used for same term)
1297
* #8735: LaTeX: wrong internal links in pdf to captioned code-blocks when
1298
:confval:`numfig` is not True
1299
* #8442: LaTeX: some indexed terms are ignored when using xelatex engine
1300
(or pdflatex and :confval:`latex_use_xindy` set to True) with memoir class
1301
* #8750: LaTeX: URLs as footnotes fail to show in PDF if originating from
1302
inside function type signatures
1303
* #8780: LaTeX: long words in narrow columns may not be hyphenated
1304
* #8788: LaTeX: ``\titleformat`` last argument in sphinx.sty should be
1305
bracketed, not braced (and is anyhow not needed)
1306
* #8849: LaTex: code-block printed out of margin (see the opt-in LaTeX syntax
1307
boolean :ref:`verbatimforcewraps <latexsphinxsetupforcewraps>` for use via
1308
the :ref:`'sphinxsetup' <latexsphinxsetup>` key of ``latex_elements``)
1309
* #8183: LaTeX: Remove substitution_reference nodes from doctree only on LaTeX
1310
builds
1311
* #8865: LaTeX: Restructure the index nodes inside title nodes only on LaTeX
1312
builds
1313
* #8796: LaTeX: potentially critical low level TeX coding mistake has gone
1314
unnoticed so far
1315
* C, :rst:dir:`c:alias` skip symbols without explicit declarations
1316
instead of crashing.
1317
* C, :rst:dir:`c:alias` give a warning when the root symbol is not declared.
1318
* C, ``expr`` role should start symbol lookup in the current scope.
1319
* #8655: autodoc: Failed to generate document if target module contains an
1320
object that raises an exception on ``hasattr()``
1321
1322
-------------------------------------------------------------------
1323
Wed Jan 13 08:15:17 UTC 2021 - Markéta Machová <mmachova@suse.com>
1324
1325
- Update to 3.4.3
1326
* Bugfix release, see upstream CHANGES
1327
1328
-------------------------------------------------------------------
1329
Mon Jan 11 14:09:59 UTC 2021 - Markéta Machová <mmachova@suse.com>
1330
1331
- Do not download python (and requests) documentation in the runtime.
1332
- Add file requests.inv
1333
1334
-------------------------------------------------------------------
1335
Tue Dec 29 20:31:46 UTC 2020 - Dirk Müller <dmueller@suse.com>
1336
1337
- update to 3.4.1:
1338
* #8105: autodoc: the signature of class constructor will be shown for decorated
1339
classes, not a signature of decorator
1340
* #8119: autodoc: Allow to determine whether a member not included in
1341
``__all__`` attribute of the module should be documented or not via
1342
:event:`autodoc-skip-member` event
1343
* #8219: autodoc: Parameters for generic class are not shown when super class is
1344
a generic class and show-inheritance option is given (in Python 3.7 or above)
1345
* autodoc: Add ``Documenter.config`` as a shortcut to access the config object
1346
* autodoc: Add Optional[t] to annotation of function and method if a default
1347
value equal to None is set.
1348
* #8209: autodoc: Add ``:no-value:`` option to :rst:dir:`autoattribute` and
1349
:rst:dir:`autodata` directive to suppress the default value of the variable
1350
* #8460: autodoc: Support custom types defined by typing.NewType
1351
* #8285: napoleon: Add :confval:`napoleon_attr_annotations` to merge type hints
1352
on source code automatically if any type is specified in docstring
1353
* #8236: napoleon: Support numpydoc's "Receives" section
1354
* #6914: Add a new event :event:`warn-missing-reference` to custom warning
1355
messages when failed to resolve a cross-reference
1356
* #6914: Emit a detailed warning when failed to resolve a ``:ref:`` reference
1357
* #6629: linkcheck: The builder now handles rate limits. See
1358
:confval:`linkcheck_retry_on_rate_limit` for details.
1359
* Large number of bugfixes, see included NEWS
1360
- remove sphinx-pr8520-fix-AliasNode-copy.patch (upstream)
1361
1362
-------------------------------------------------------------------
1363
Fri Dec 4 17:19:43 UTC 2020 - Benjamin Greiner <code@bnavigator.de>
1364
1365
- Remove unused mypy from BuildRequires in :test
1366
- Fix the intersphinx inventory bundle for multiple python flavors
1367
gh#openSUSE/python-rpm-macros#66
1368
- Fix failing graphviz dot calls by including packages for png
1369
and pdf formats. The png fail was masked by an incorrect use of
1370
a shell command chain. Fails for pdf format were in the tests.
1371
- Add sphinx-pr8520-fix-AliasNode-copy.patch to fix failing
1372
manpages build -- gh#sphinx-doc/sphinx#8520
1373
1374
-------------------------------------------------------------------
1375
Thu Nov 26 09:18:00 UTC 2020 - Dirk Mueller <dmueller@suse.com>
1376
1377
- update to 3.3.1:
1378
* #8372: autodoc: autoclass directive became slower than Sphinx-3.2
1379
* #7727: autosummary: raise PycodeError when documenting python package
1380
* #8350: autosummary: autosummary_mock_imports causes slow down builds
1381
* #8364: C, properly initialize attributes in empty symbols.
1382
* #8399: i18n: Put system locale path after the paths specified by configuration
1383
* #8100: html: Show a better error message for failures on copying
1384
html_static_files
1385
* #8141: C: added a ``maxdepth`` option to :rst:dir:`c:alias` to insert
1386
nested declarations.
1387
* #8081: LaTeX: Allow to add LaTeX package via ``app.add_latex_package()`` until
1388
just before writing .tex file
1389
* #7996: manpage: Add :confval:`man_make_section_directory` to make a section
1390
directory on build man page
1391
* #8289: epub: Allow to suppress "duplicated ToC entry found" warnings from epub
1392
builder using :confval:`suppress_warnings`.
1393
* #8298: sphinx-quickstart: Add :option:`sphinx-quickstart --no-sep` option
1394
* #8304: sphinx.testing: Register public markers in sphinx.testing.fixtures
1395
* #8051: napoleon: use the obj role for all See Also items
1396
* #8050: napoleon: Apply :confval:`napoleon_preprocess_types` to every field
1397
* C and C++, show line numbers for previous declarations when duplicates are
1398
detected.
1399
* #8183: Remove substitution_reference nodes from doctree only on LaTeX builds
1400
* bugfixes
1401
- remove sphinx-pygments-compat.patch (obsolete)
1402
1403
-------------------------------------------------------------------
1404
Wed Nov 4 11:10:14 UTC 2020 - Benjamin Greiner <code@bnavigator.de>
1405
1406
- Fix the lang collection macro override.
1407
* gh#openSUSE/python-rpm-macros#66
1408
* gh#openSUSE/python-rpm-macros#74
1409
1410
-------------------------------------------------------------------
1411
Tue Nov 3 19:56:15 UTC 2020 - Benjamin Greiner <code@bnavigator.de>
1412
1413
- Fix lang files collection for multiple flavors
1414
* gh#openSUSE/python-rpm-macros#5
1415
* gh#openSUSE/python-rpm-macros#66
1416
1417
-------------------------------------------------------------------
1418
Mon Sep 28 13:45:37 UTC 2020 - Dirk Mueller <dmueller@suse.com>
1419
1420
- add sphinx-pygments-compat.patch (fix tests with newer pygments)
1421
1422
-------------------------------------------------------------------
1423
Tue Aug 18 14:44:04 UTC 2020 - Dirk Mueller <dmueller@suse.com>
1424
1425
- update to 3.2.1:
1426
* #8095: napoleon: Add :confval:`napoleon_preprocess_types` to enable the type
1427
preprocessor for numpy style docstrings
1428
* #8114: C and C++, parse function attributes after parameters and qualifiers.
1429
* #8074: napoleon: Crashes during processing C-ext module
1430
* #8088: napoleon: "Inline literal start-string without end-string" warning in
1431
Numpy style Parameters section
1432
* #8084: autodoc: KeyError is raised on documenting an attribute of the broken
1433
class
1434
* #8091: autodoc: AttributeError is raised on documenting an attribute on Python
1435
3.5.2
1436
* #8099: autodoc: NameError is raised when target code uses ``TYPE_CHECKING``
1437
* C++, fix parsing of template template paramters, broken by the fix of #7944
1438
1439
-------------------------------------------------------------------
1440
Thu Aug 13 14:02:03 UTC 2020 - Dirk Mueller <dmueller@suse.com>
1441
1442
1443
- update to 3.2.0:
1444
* #2076: autodoc: Allow overriding of exclude-members in skip-member function
1445
* #8034: autodoc: ``:private-member:`` can take an explicit list of member names
1446
to be documented
1447
* #2024: autosummary: Add :confval:`autosummary_filename_map` to avoid conflict
1448
of filenames between two object with different case
1449
* #8011: autosummary: Support instance attributes as a target of autosummary
1450
directive
1451
* #7849: html: Add :confval:`html_codeblock_linenos_style` to change the style
1452
of line numbers for code-blocks
1453
* #7853: C and C++, support parameterized GNU style attributes.
1454
* #7888: napoleon: Add aliases Warn and Raise.
1455
* #7690: napoleon: parse type strings and make them hyperlinks as possible. The
1456
conversion rule can be updated via :confval:`napoleon_type_aliases`
1457
* #8049: napoleon: Create a hyperlink for each the type of parameter when
1458
:confval:`napoleon_use_params` is False
1459
* C, added :rst:dir:`c:alias` directive for inserting copies
1460
of existing declarations.
1461
* #7745: html: inventory is broken if the docname contains a space
1462
* #7991: html search: Allow searching for numbers
1463
* #7902: html theme: Add a new option :confval:`globaltoc_maxdepth` to control
1464
the behavior of globaltoc in sidebar
1465
* #7840: i18n: Optimize the dependencies check on bootstrap
1466
* #7768: i18n: :confval:`figure_language_filename` supports ``docpath`` token
1467
* #5208: linkcheck: Support checks for local links
1468
* #5090: setuptools: Link verbosity to distutils' -v and -q option
1469
* #6698: doctest: Add ``:trim-doctest-flags:`` and ``:no-trim-doctest-flags:``
1470
options to doctest, testcode and testoutput directives
1471
* #7052: add ``:noindexentry:`` to the Python, C, C++, and Javascript domains.
1472
Update the documentation to better reflect the relationship between this option
1473
and the ``:noindex:`` option.
1474
* #7899: C, add possibility of parsing of some pre-v3 style type directives and
1475
roles and try to convert them to equivalent v3 directives/roles.
1476
Set the new option :confval:`c_allow_pre_v3` to ``True`` to enable this.
1477
The warnings printed from this functionality can be suppressed by setting
1478
:confval:`c_warn_on_allowed_pre_v3`` to ``True``.
1479
The functionality is immediately deprecated.
1480
* #7999: C, add support for named variadic macro arguments.
1481
* #8071: Allow to suppress "self referenced toctrees" warning
1482
* #7886: autodoc: TypeError is raised on mocking generic-typed classes
1483
* #7935: autodoc: function signature is not shown when the function has a
1484
parameter having ``inspect._empty`` as its default value
1485
* #7901: autodoc: type annotations for overloaded functions are not resolved
1486
* #904: autodoc: An instance attribute cause a crash of autofunction directive
1487
* #1362: autodoc: ``private-members`` option does not work for class attributes
1488
* #7983: autodoc: Generator type annotation is wrongly rendered in py36
1489
* #8030: autodoc: An uninitialized annotated instance variable is not documented
1490
when ``:inherited-members:`` option given
1491
* #8032: autodoc: A type hint for the instance variable defined at parent class
1492
is not shown in the document of the derived class
1493
* #8041: autodoc: An annotated instance variable on super class is not
1494
documented when derived class has other annotated instance variables
1495
* #7839: autosummary: cannot handle umlauts in function names
1496
* #7865: autosummary: Failed to extract summary line when abbreviations found
1497
* #7866: autosummary: Failed to extract correct summary line when docstring
1498
contains a hyperlink target
1499
* #7469: autosummary: "Module attributes" header is not translatable
1500
* #7940: apidoc: An extra newline is generated at the end of the rst file if a
1501
module has submodules
1502
* #4258: napoleon: decorated special methods are not shown
1503
* #7799: napoleon: parameters are not escaped for combined params in numpydoc
1504
* #7780: napoleon: multiple paramaters declaration in numpydoc was wrongly
1505
recognized when napoleon_use_params=True
1506
* #7715: LaTeX: ``numfig_secnum_depth > 1`` leads to wrong figure links
1507
* #7846: html theme: XML-invalid files were generated
1508
* #7894: gettext: Wrong source info is shown when using rst_epilog
1509
* #7691: linkcheck: HEAD requests are not used for checking
1510
* #4888: i18n: Failed to add an explicit title to ``:ref:`` role on translation
1511
* #7928: py domain: failed to resolve a type annotation for the attribute
1512
* #8008: py domain: failed to parse a type annotation containing ellipsis
1513
* #7994: std domain: option directive does not generate old node_id compatible
1514
with 2.x or older
1515
* #7968: i18n: The content of ``math`` directive is interpreted as reST on
1516
translation
1517
* #7768: i18n: The ``root`` element for :confval:`figure_language_filename` is
1518
not a path that user specifies in the document
1519
* #7993: texinfo: TypeError is raised for nested object descriptions
1520
* #7993: texinfo: a warning not supporting desc_signature_line node is shown
1521
* #7869: :rst:role:`abbr` role without an explanation will show the explanation
1522
from the previous abbr role
1523
* #8048: graphviz: graphviz.css was copied on building non-HTML document
1524
* C and C++, removed ``noindex`` directive option as it did
1525
nothing.
1526
* #7619: Duplicated node IDs are generated if node has multiple IDs
1527
* #2050: Symbols sections are appeared twice in the index page
1528
* #8017: Fix circular import in sphinx.addnodes
1529
* #7986: CSS: make "highlight" selector more robust
1530
* #7944: C++, parse non-type template parameters starting with
1531
a dependent qualified name.
1532
* C, don't deepcopy the entire symbol table and make a mess every time an
1533
enumerator is handled.
1534
1535
-------------------------------------------------------------------
1536
Thu Jul 16 12:52:54 UTC 2020 - Matej Cepl <mcepl@suse.com>
1537
1538
- In the new multiversion world, python*.inv is in python3.8
1539
directory not python3.
1540
1541
-------------------------------------------------------------------
1542
Sat Jul 11 18:49:26 UTC 2020 - Arun Persaud <arun@gmx.de>
1543
1544
- update to version 3.1.2:
1545
* Incompatible changes
1546
+ #7650: autodoc: the signature of base function will be shown for
1547
decorated functions, not a signature of decorator
1548
* Bugs fixed
1549
+ #7844: autodoc: Failed to detect module when relative module
1550
name given
1551
+ #7856: autodoc: AttributeError is raised when non-class object
1552
is given to the autoclass directive
1553
+ #7850: autodoc: KeyError is raised for invalid mark up when
1554
autodoc_typehints is 'description'
1555
+ #7812: autodoc: crashed if the target name matches to both an
1556
attribute and module that are same name
1557
+ #7650: autodoc: function signature becomes "(*args, **kwargs)"
1558
if the function is decorated by generic decorator
1559
+ #7812: autosummary: generates broken stub files if the target
1560
code contains an attribute and module that are same name
1561
+ #7806: viewcode: Failed to resolve viewcode references on 3rd
1562
party builders
1563
+ #7838: html theme: List items have extra vertical space
1564
+ #7878: html theme: Undesired interaction between "overflow" and
1565
"float"
1566
1567
- changes from version 3.1.1:
1568
* Incompatible changes
1569
+ #7808: napoleon: a type for attribute are represented as typed
1570
field
1571
* Features added
1572
+ #7807: autodoc: Show detailed warning when type_comment is
1573
mismatched with its signature
1574
* Bugs fixed
1575
+ #7808: autodoc: Warnings raised on variable and attribute type
1576
annotations
1577
+ #7802: autodoc: EOFError is raised on parallel build
1578
+ #7821: autodoc: TypeError is raised for overloaded C-ext
1579
function
1580
+ #7805: autodoc: an object which descriptors returns is
1581
unexpectedly documented
1582
+ #7807: autodoc: wrong signature is shown for the function using
1583
contextmanager
1584
+ #7812: autosummary: generates broken stub files if the target
1585
code contains an attribute and module that are same name
1586
+ #7808: napoleon: Warnings raised on variable and attribute type
1587
annotations
1588
+ #7811: sphinx.util.inspect causes circular import problem
1589
1590
- changes from version 3.1.0:
1591
* Dependencies
1592
+ #7746: mathjax: Update to 2.7.5
1593
* Incompatible changes
1594
+ #7477: imgconverter: Invoke "magick convert" command by default
1595
on Windows
1596
* Deprecated
1597
+ The first argument for
1598
sphinx.ext.autosummary.generate.AutosummaryRenderer has been
1599
changed to Sphinx object
1600
+ "sphinx.ext.autosummary.generate.AutosummaryRenderer" takes an
1601
object type as an argument
1602
+ The "ignore" argument of
1603
"sphinx.ext.autodoc.Documenter.get_doc()"
1604
+ The "template_dir" argument of "sphinx.ext.autosummary.generate.
1605
AutosummaryRenderer"
1606
+ The "module" argument of "sphinx.ext.autosummary.generate.
1607
find_autosummary_in_docstring()"
1608
+ The "builder" argument of "sphinx.ext.autosummary.generate.
1609
generate_autosummary_docs()"
1610
+ The "template_dir" argument of "sphinx.ext.autosummary.generate.
1611
generate_autosummary_docs()"
1612
+ The "ignore" argument of
1613
"sphinx.util.docstring.prepare_docstring()"
1614
+ "sphinx.ext.autosummary.generate.AutosummaryRenderer.exists()"
1615
+ "sphinx.util.rpartition()"
1616
* Features added
1617
+ LaTeX: Make the "toplevel_sectioning" setting optional in LaTeX
1618
theme
1619
+ LaTeX: Allow to override papersize and pointsize from LaTeX
1620
themes
1621
+ LaTeX: Add :confval:`latex_theme_options` to override theme
1622
options
1623
+ #7410: Allow to suppress "circular toctree references detected"
1624
warnings using :confval:`suppress_warnings`
1625
+ C, added scope control directives, :rst:dir:`c:namespace`,
1626
:rst:dir:`c:namespace-push`, and :rst:dir:`c:namespace-pop`.
1627
+ #2044: autodoc: Suppress default value for instance attributes
1628
+ #7473: autodoc: consider a member public if docstring contains
1629
":meta public:" in info-field-list
1630
+ #7487: autodoc: Allow to generate docs for singledispatch
1631
functions by py:autofunction
1632
+ #7143: autodoc: Support final classes and methods
1633
+ #7384: autodoc: Support signatures defined by "__new__()",
1634
metaclasses and builtin base classes
1635
+ #2106: autodoc: Support multiple signatures on docstring
1636
+ #4422: autodoc: Support GenericAlias in Python 3.7 or above
1637
+ #3610: autodoc: Support overloaded functions
1638
+ #7722: autodoc: Support TypeVar
1639
+ #7466: autosummary: headings in generated documents are not
1640
translated
1641
+ #7490: autosummary: Add ":caption:" option to autosummary
1642
directive to set a caption to the toctree
1643
+ #7469: autosummary: Support module attributes
1644
+ #248, #6040: autosummary: Add ":recursive:" option to
1645
autosummary directive to generate stub files recursively
1646
+ #4030: autosummary: Add :confval:`autosummary_context` to add
1647
template variables for custom templates
1648
+ #7530: html: Support nested <kbd> elements
1649
+ #7481: html theme: Add right margin to footnote/citation labels
1650
+ #7482, #7717: html theme: CSS spacing for code blocks with
1651
captions and line numbers
1652
+ #7443: html theme: Add new options :confval:`globaltoc_collapse`
1653
and :confval:`globaltoc_includehidden` to control the behavior
1654
of globaltoc in sidebar
1655
+ #7484: html theme: Avoid clashes between sidebar and other
1656
blocks
1657
+ #7476: html theme: Relbar breadcrumb should contain current page
1658
+ #7506: html theme: A canonical URL is not escaped
1659
+ #7533: html theme: Avoid whitespace at the beginning of
1660
genindex.html
1661
+ #7541: html theme: Add a "clearer" at the end of the "body"
1662
+ #7542: html theme: Make admonition/topic/sidebar scrollable
1663
+ #7543: html theme: Add top and bottom margins to tables
1664
+ #7695: html theme: Add viewport meta tag for basic theme
1665
+ #7721: html theme: classic: default codetextcolor/codebgcolor
1666
doesn't override Pygments
1667
+ C and C++: allow semicolon in the end of declarations.
1668
+ C++, parse parameterized noexcept specifiers.
1669
+ #7294: C++, parse expressions with user-defined literals.
1670
+ C++, parse trailing return types.
1671
+ #7143: py domain: Add ":final:" option to :rst:dir:`py:class:`,
1672
:rst:dir:`py:exception:` and :rst:dir:`py:method:` directives
1673
+ #7596: py domain: Change a type annotation for variables to a
1674
hyperlink
1675
+ #7770: std domain: :rst:dir:`option` directive support arguments
1676
in the form of "foo[=bar]"
1677
+ #7582: napoleon: a type for attribute are represented like type
1678
annotation
1679
+ #7734: napoleon: overescaped trailing underscore on attribute
1680
+ #7247: linkcheck: Add :confval:`linkcheck_request_headers` to
1681
send custom HTTP headers for specific host
1682
+ #7792: setuptools: Support "--verbosity" option
1683
+ #7683: Add "allowed_exceptions" parameter to "Sphinx.emit()" to
1684
allow handlers to raise specified exceptions
1685
+ #7295: C++, parse (trailing) requires clauses.
1686
* Bugs fixed
1687
+ #6703: autodoc: incremental build does not work for imported
1688
objects
1689
+ #7564: autodoc: annotations not to be shown for descriptors
1690
+ #6588: autodoc: Decorated inherited method has no documentation
1691
+ #7469: autodoc: The change of autodoc-process-docstring for
1692
variables is cached unexpectedly
1693
+ #7559: autodoc: misdetects a sync function is async
1694
+ #6857: autodoc: failed to detect a classmethod on Enum class
1695
+ #7562: autodoc: a typehint contains spaces is wrongly rendered
1696
under autodoc_typehints='description' mode
1697
+ #7551: autodoc: failed to import nested class
1698
+ #7362: autodoc: does not render correct signatures for built-in
1699
functions
1700
+ #7654: autodoc: "Optional[Union[foo, bar]]" is presented as
1701
"Union[foo, bar, None]"
1702
+ #7629: autodoc: autofunction emits an unfriendly warning if an
1703
invalid object specified
1704
+ #7650: autodoc: undecorated signature is shown for decorated
1705
functions
1706
+ #7676: autodoc: typo in the default value of
1707
autodoc_member_order
1708
+ #7676: autodoc: wrong value for :member-order: option is ignored
1709
silently
1710
+ #7676: autodoc: member-order="bysource" does not work for C
1711
module
1712
+ #3673: autodoc: member-order="bysource" does not work for a
1713
module having __all__
1714
+ #7668: autodoc: wrong retann value is passed to a handler of
1715
autodoc-proccess-signature
1716
+ #7711: autodoc: fails with ValueError when processing numpy
1717
objects
1718
+ #7791: autodoc: TypeError is raised on documenting
1719
singledispatch function
1720
+ #7551: autosummary: a nested class is indexed as non-nested
1721
class
1722
+ #7661: autosummary: autosummary directive emits warnings twices
1723
if failed to import the target module
1724
+ #7685: autosummary: The template variable "members" contains
1725
imported members even if
1726
:confval:`autossummary_imported_members` is False
1727
+ #7671: autosummary: The location of import failure warning is
1728
missing
1729
+ #7535: sphinx-autogen: crashes when custom template uses
1730
inheritance
1731
+ #7536: sphinx-autogen: crashes when template uses i18n feature
1732
+ #7781: sphinx-build: Wrong error message when outdir is not
1733
directory
1734
+ #7653: sphinx-quickstart: Fix multiple directory creation for
1735
nested relpath
1736
+ #2785: html: Bad alignment of equation links
1737
+ #7718: html theme: some themes does not respect background color
1738
of Pygments style (agogo, haiku, nature, pyramid, scrolls,
1739
sphinxdoc and traditional)
1740
+ #7544: html theme: inconsistent padding in admonitions
1741
+ #7581: napoleon: bad parsing of inline code in attribute
1742
docstrings
1743
+ #7628: imgconverter: runs imagemagick once unnecessary for
1744
builders not supporting images
1745
+ #7610: incorrectly renders consecutive backslashes for
1746
docutils-0.16
1747
+ #7646: handle errors on event handlers
1748
+ #4187: LaTeX: EN DASH disappears from PDF bookmarks in Japanese
1749
documents
1750
+ #7701: LaTeX: Anonymous indirect hyperlink target causes
1751
duplicated labels
1752
+ #7723: LaTeX: pdflatex crashed when URL contains a single quote
1753
+ #7756: py domain: The default value for positional only argument
1754
is not shown
1755
+ #7760: coverage: Add :confval:`coverage_show_missing_items` to
1756
show coverage result to console
1757
+ C++, fix rendering and xrefs in nested names explicitly starting
1758
in global scope, e.g., "::A::B".
1759
+ C, fix rendering and xrefs in nested names explicitly starting
1760
in global scope, e.g., ".A.B".
1761
+ #7763: C and C++, don't crash during display stringification of
1762
unary expressions and fold expressions.
1763
1764
-------------------------------------------------------------------
1765
Sat May 30 23:25:39 UTC 2020 - Arun Persaud <arun@gmx.de>
1766
1767
- update to version 3.0.4:
1768
* Bugs fixed
1769
+ #7567: autodoc: parametrized types are shown twice for generic
1770
types
1771
+ #7637: autodoc: system defined TypeVars are shown in Python 3.9
1772
+ #7611: md5 fails when OpenSSL FIPS is enabled
1773
+ #7626: release package does not contain "CODE_OF_CONDUCT"
1774
1775
-------------------------------------------------------------------
1776
Mon May 4 10:17:24 UTC 2020 - Jan Zerebecki <jzerebecki@suse.com>
1777
1778
- Add python3.inv as a specific Source.
1779
- update to version 3.0.3
1780
* Features added
1781
* C, parse array declarators with static, qualifiers, and VLA specification.
1782
* Bugs fixed
1783
* #7516: autodoc: crashes if target object raises an error on accessing
1784
its attributes
1785
- update to version 3.0.2
1786
* Features added
1787
* C, parse attributes and add :confval:`c_id_attributes`
1788
and :confval:`c_paren_attributes` to support user-defined attributes.
1789
* Bugs fixed
1790
* #7461: py domain: fails with IndexError for empty tuple in type annotation
1791
* #7510: py domain: keyword-only arguments are documented as having a default of
1792
None
1793
* #7418: std domain: :rst:role:`term` role could not match case-insensitively
1794
* #7461: autodoc: empty tuple in type annotation is not shown correctly
1795
* #7479: autodoc: Sphinx builds has been slower since 3.0.0 on mocking
1796
* C++, fix spacing issue in east-const declarations.
1797
* #7414: LaTeX: Xindy language options were incorrect
1798
* sphinx crashes with ImportError on python3.5.1
1799
1800
- update to 3.0.1
1801
* Incompatible changes
1802
* #7418: std domain: :rst:dir:`term` role becomes case sensitive
1803
* Bugs fixed
1804
* #7428: py domain: a reference to class ``None`` emits a nitpicky warning
1805
* #7445: py domain: a return annotation ``None`` in the function signature is
1806
not converted to a hyperlink when using intersphinx
1807
* #7418: std domain: duplication warning for glossary terms is case insensitive
1808
* #7438: C++, fix merging overloaded functions in parallel builds.
1809
* #7422: autodoc: fails with ValueError when using autodoc_mock_imports
1810
* #7435: autodoc: ``autodoc_typehints='description'`` doesn't suppress typehints
1811
in signature for classes/methods
1812
* #7451: autodoc: fails with AttributeError when an object returns non-string
1813
object as a ``__doc__`` member
1814
* #7423: crashed when giving a non-string object to logger
1815
* #7479: html theme: Do not include xmlns attribute with HTML 5 doctype
1816
* #7426: html theme: Escape some links in HTML templates
1817
1818
- update to version 3.0.0
1819
* Dependencies
1820
* LaTeX: drop dependency on :program:`extractbb` for image inclusion in
1821
Japanese documents as ``.xbb`` files are unneeded by :program:`dvipdfmx`
1822
since TeXLive2015 (refs: #6189)
1823
* babel-2.0 or above is available (Unpinned)
1824
* Incompatible changes
1825
* Drop features and APIs deprecated in 1.8.x
1826
* #247: autosummary: stub files are overwritten automatically by default. see
1827
:confval:`autosummary_generate_overwrite` to change the behavior
1828
* #5923: autodoc: the members of ``object`` class are not documented by default
1829
when ``:inherited-members:`` and ``:special-members:`` are given.
1830
* #6830: py domain: ``meta`` fields in info-field-list becomes reserved. They
1831
are not displayed on output document now
1832
* #6417: py domain: doctree of desc_parameterlist has been changed. The
1833
argument names, annotations and default values are wrapped with inline node
1834
* The structure of ``sphinx.events.EventManager.listeners`` has changed
1835
* Due to the scoping changes for :rst:dir:`productionlist` some uses of
1836
:rst:role:`token` must be modified to include the scope which was previously
1837
ignored.
1838
* #6903: Internal data structure of Python, reST and standard domains have
1839
changed. The node_id is added to the index of objects and modules. Now they
1840
contains a pair of docname and node_id for cross reference.
1841
* #7276: C++ domain: Non intended behavior is removed such as ``say_hello_``
1842
links to ``.. cpp:function:: say_hello()``
1843
* #7210: js domain: Non intended behavior is removed such as ``parseInt_`` links
1844
to ``.. js:function:: parseInt``
1845
* #7229: rst domain: Non intended behavior is removed such as ``numref_`` links
1846
to ``.. rst:role:: numref``
1847
* #6903: py domain: Non intended behavior is removed such as ``say_hello_``
1848
links to ``.. py:function:: say_hello()``
1849
* #7246: py domain: Drop special cross reference helper for exceptions,
1850
functions and methods
1851
* The C domain has been rewritten, with additional directives and roles.
1852
The existing ones are now more strict, resulting in new warnings.
1853
* The attribute ``sphinx_cpp_tagname`` in the ``desc_signature_line`` node
1854
has been renamed to ``sphinx_line_type``.
1855
* #6462: double backslashes in domain directives are no longer replaced by
1856
single backslashes as default. A new configuration value
1857
:confval:`strip_signature_backslash` can be used by users to reenable it.
1858
* #7222: ``sphinx.util.inspect.unwrap()`` is renamed to ``unwrap_all()``
1859
* Deprecated
1860
* ``desc_signature['first']``
1861
* ``sphinx.directives.DescDirective``
1862
* ``sphinx.domains.std.StandardDomain.add_object()``
1863
* ``sphinx.domains.python.PyDecoratorMixin``
1864
* ``sphinx.ext.autodoc.get_documenters()``
1865
* ``sphinx.ext.autosummary.process_autosummary_toc()``
1866
* ``sphinx.parsers.Parser.app``
1867
* ``sphinx.testing.path.Path.text()``
1868
* ``sphinx.testing.path.Path.bytes()``
1869
* ``sphinx.util.inspect.getargspec()``
1870
* ``sphinx.writers.latex.LaTeXWriter.format_docclass()``
1871
* Features added
1872
* #247: autosummary: Add :confval:`autosummary_generate_overwrite` to overwrite
1873
old stub file
1874
* #5923: autodoc: ``:inherited-members:`` option takes a name of anchestor class
1875
not to document inherited members of the class and uppers
1876
* #6830: autodoc: consider a member private if docstring contains
1877
``:meta private:`` in info-field-list
1878
* #7165: autodoc: Support Annotated type (PEP-593)
1879
* #2815: autodoc: Support singledispatch functions and methods
1880
* #7079: autodoc: :confval:`autodoc_typehints` accepts ``"description"``
1881
configuration. It shows typehints as object description
1882
* #7314: apidoc: Propagate ``--maxdepth`` option through package documents
1883
* #6558: glossary: emit a warning for duplicated glossary entry
1884
* #3106: domain: Register hyperlink target for index page automatically
1885
* #6558: std domain: emit a warning for duplicated generic objects
1886
* #6830: py domain: Add new event: :event:`object-description-transform`
1887
* #6895: py domain: Do not emit nitpicky warnings for built-in types
1888
* py domain: Support lambda functions in function signature
1889
* #6417: py domain: Allow to make a style for arguments of functions and methods
1890
* #7238, #7239: py domain: Emit a warning on describing a python object if the
1891
entry is already added as the same name
1892
* #7341: py domain: type annotations in singature are converted to cross refs
1893
* Support priority of event handlers. For more detail, see
1894
:py:meth:`.Sphinx.connect()`
1895
* #3077: Implement the scoping for :rst:dir:`productionlist` as indicated
1896
in the documentation.
1897
* #1027: Support backslash line continuation in :rst:dir:`productionlist`.
1898
* #7108: config: Allow to show an error message from conf.py via ``ConfigError``
1899
* #7032: html: :confval:`html_scaled_image_link` will be disabled for images having
1900
``no-scaled-link`` class
1901
* #7144: Add CSS class indicating its domain for each desc node
1902
* #7211: latex: Use babel for Chinese document when using XeLaTeX
1903
* #6672: LaTeX: Support LaTeX Theming (experimental)
1904
* #7005: LaTeX: Add LaTeX styling macro for :rst:role:`kbd` role
1905
* #7220: genindex: Show "main" index entries at first
1906
* #7103: linkcheck: writes all links to ``output.json``
1907
* #7025: html search: full text search can be disabled for individual document
1908
using ``:nosearch:`` file-wide metadata
1909
* #7293: html search: Allow to override JavaScript splitter via
1910
``SearchLanguage.js_splitter_code``
1911
* #7142: html theme: Add a theme option: ``pygments_dark_style`` to switch the
1912
style of code-blocks in dark mode
1913
* The C domain has been rewritten adding for example:
1914
1915
- Cross-referencing respecting the current scope.
1916
- Possible to document anonymous entities.
1917
- More specific directives and roles for each type of entitiy,
1918
e.g., handling scoping of enumerators.
1919
- New role :rst:role:`c:expr` for rendering expressions and types
1920
in text.
1921
1922
* Added ``SphinxDirective.get_source_info()``
1923
and ``SphinxRole.get_source_info()``.
1924
* #7324: sphinx-build: Emit a warning if multiple files having different file
1925
extensions for same document found
1926
* Added ``ObjectDescription.transform_content()``.
1927
* Bugs fixed
1928
* C++, fix cross reference lookup in certain cases involving
1929
function overloads.
1930
* #5078: C++, fix cross reference lookup when a directive contains multiple
1931
declarations.
1932
* C++, suppress warnings for directly dependent typenames in cross references
1933
generated automatically in signatures.
1934
* #5637: autodoc: Incorrect handling of nested class names on show-inheritance
1935
* #7267: autodoc: error message for invalid directive options has wrong location
1936
* #7329: autodoc: info-field-list is wrongly generated from type hints into the
1937
class description even if ``autoclass_content='class'`` set
1938
* #7331: autodoc: a cython-function is not recognized as a function
1939
* #5637: inheritance_diagram: Incorrect handling of nested class names
1940
* #7139: ``code-block:: guess`` does not work
1941
* #7325: html: source_suffix containing dot leads to wrong source link
1942
* #7357: html: Resizing SVG image fails with ValueError
1943
* #7278: html search: Fix use of ``html_file_suffix`` instead of
1944
``html_link_suffix`` in search results
1945
* #7297: html theme: ``bizstyle`` does not support ``sidebarwidth``
1946
* #3842: singlehtml: Path to images broken when master doc is not in source root
1947
* #7179: std domain: Fix whitespaces are suppressed on referring GenericObject
1948
* #7289: console: use bright colors instead of bold
1949
* #1539: C, parse array types.
1950
* #2377: C, parse function pointers even in complex types.
1951
* #7345: sphinx-build: Sphinx crashes if output directory exists as a file
1952
* #7290: sphinx-build: Ignore bdb.BdbQuit when handling exceptions
1953
* #6240: napoleon: Attributes and Methods sections ignore :noindex: option
1954
* #7364: autosummary: crashed when :confval:`autosummary_generate` is False
1955
* #7370: autosummary: raises UnboundLocalError when unknown module given
1956
* #7367: C++, alternate operator spellings are now supported.
1957
* C, alternate operator spellings are now supported.
1958
* #7368: C++, comma operator in expressions, pack expansion in template
1959
argument lists, and more comprehensive error messages in some cases.
1960
* C, C++, fix crash and wrong duplicate warnings related to anon symbols.
1961
* #6477: Escape first "!" in a cross reference linking no longer possible
1962
* #7219: py domain: The index entry generated by ``py:function`` directive is
1963
different with one from ``index`` directive with "builtin" type
1964
* #7301: capital characters are not allowed for node_id
1965
* #7301: epub: duplicated node_ids are generated
1966
* #6564: html: a width of table was ignored on HTML builder
1967
* #7401: Incorrect argument is passed for :event:`env-get-outdated` handlers
1968
* #7355: autodoc: a signature of cython-function is not recognized well
1969
* #7222: autodoc: ``__wrapped__`` functions are not documented correctly
1970
* #7409: intersphinx: ValueError is raised when an extension sets up
1971
:confval:`intersphinx_mapping` on :event:`config-inited` event
1972
* #7343: Sphinx builds has been slower since 2.4.0 on debug mode
1973
1974
- update to version 2.4.4
1975
* Bugs fixed
1976
* #7197: LaTeX: platex cause error to build image directive with target url
1977
* #7223: Sphinx builds has been slower since 2.4.0
1978
1979
- update to version 2.4.3
1980
* Bugs fixed
1981
* #7184: autodoc: ``*args`` and ``**kwarg`` in type comments are not handled
1982
properly
1983
* #7189: autodoc: classmethod coroutines are not detected
1984
* #7183: intersphinx: ``:attr:`` reference to property is broken
1985
* #6244, #6387: html search: Search breaks/hangs when built with dirhtml builder
1986
* #7195: todo: emit doctree-resolved event with non-document node incorrectly
1987
1988
- update to version 2.4.2
1989
* Bugs fixed
1990
* #7138: autodoc: ``autodoc.typehints`` crashed when variable has unbound object
1991
as a value
1992
* #7156: autodoc: separator for keyword only arguments is not shown
1993
* #7146: autodoc: IndexError is raised on suppressed type_comment found
1994
* #7161: autodoc: typehints extension does not support parallel build
1995
* #7178: autodoc: TypeError is raised on fetching type annotations
1996
* #7151: crashed when extension assigns a value to ``env.indexentries``
1997
* #7170: text: Remove debug print
1998
* #7137: viewcode: Avoid to crash when non-python code given
1999
2000
- update to version 2.4.1
2001
* Bugs fixed
2002
* #7120: html: crashed when on scaling SVG images which have float dimentions
2003
* #7126: autodoc: TypeError: 'getset_descriptor' object is not iterable
2004
2005
- update to version 2.4.0
2006
* Deprecated
2007
* The ``decode`` argument of ``sphinx.pycode.ModuleAnalyzer()``
2008
* ``sphinx.directives.other.Index``
2009
* ``sphinx.environment.temp_data['gloss_entries']``
2010
* ``sphinx.environment.BuildEnvironment.indexentries``
2011
* ``sphinx.environment.collectors.indexentries.IndexEntriesCollector``
2012
* ``sphinx.ext.apidoc.INITPY``
2013
* ``sphinx.ext.apidoc.shall_skip()``
2014
* ``sphinx.io.FiletypeNotFoundError``
2015
* ``sphinx.io.get_filetype()``
2016
* ``sphinx.pycode.ModuleAnalyzer.encoding``
2017
* ``sphinx.roles.Index``
2018
* ``sphinx.util.detect_encoding()``
2019
* ``sphinx.util.get_module_source()``
2020
* ``sphinx.util.inspect.Signature``
2021
* ``sphinx.util.inspect.safe_getmembers()``
2022
* ``sphinx.writers.latex.LaTeXTranslator.settings.author``
2023
* ``sphinx.writers.latex.LaTeXTranslator.settings.contentsname``
2024
* ``sphinx.writers.latex.LaTeXTranslator.settings.docclass``
2025
* ``sphinx.writers.latex.LaTeXTranslator.settings.docname``
2026
* ``sphinx.writers.latex.LaTeXTranslator.settings.title``
2027
* ``sphinx.writers.latex.ADDITIONAL_SETTINGS``
2028
* ``sphinx.writers.latex.DEFAULT_SETTINGS``
2029
* ``sphinx.writers.latex.LUALATEX_DEFAULT_FONTPKG``
2030
* ``sphinx.writers.latex.PDFLATEX_DEFAULT_FONTPKG``
2031
* ``sphinx.writers.latex.XELATEX_DEFAULT_FONTPKG``
2032
* ``sphinx.writers.latex.XELATEX_GREEK_DEFAULT_FONTPKG``
2033
* Features added
2034
* #6910: inheritance_diagram: Make the background of diagrams transparent
2035
* #6446: duration: Add ``sphinx.ext.durations`` to inspect which documents slow
2036
down the build
2037
* #6837: LaTeX: Support a nested table
2038
* #7115: LaTeX: Allow to override LATEXOPTS and LATEXMKOPTS via environment
2039
variable
2040
* #6966: graphviz: Support ``:class:`` option
2041
* #6696: html: ``:scale:`` option of image/figure directive not working for SVG
2042
images (imagesize-1.2.0 or above is required)
2043
* #6994: imgconverter: Support illustrator file (.ai) to .png conversion
2044
* autodoc: Support Positional-Only Argument separator (PEP-570 compliant)
2045
* autodoc: Support type annotations for variables
2046
* #2755: autodoc: Add new event: :event:`autodoc-before-process-signature`
2047
* #2755: autodoc: Support type_comment style (ex. ``# type: (str) -> str``)
2048
annotation (python3.8+ or `typed_ast <https://github.com/python/typed_ast>`_
2049
is required)
2050
* #7051: autodoc: Support instance variables without defaults (PEP-526)
2051
* #6418: autodoc: Add a new extension ``sphinx.ext.autodoc.typehints``. It shows
2052
typehints as object description if ``autodoc_typehints = "description"`` set.
2053
This is an experimental extension and it will be integrated into autodoc core
2054
in Sphinx-3.0
2055
* SphinxTranslator now calls visitor/departure method for super node class if
2056
visitor/departure method for original node class not found
2057
* #6418: Add new event: :event:`object-description-transform`
2058
* py domain: :rst:dir:`py:data` and :rst:dir:`py:attribute` take new options
2059
named ``:type:`` and ``:value:`` to describe its type and initial value
2060
* #6785: py domain: ``:py:attr:`` is able to refer properties again
2061
* #6772: apidoc: Add ``-q`` option for quiet mode
2062
* Bugs fixed
2063
* #6925: html: Remove redundant type="text/javascript" from <script> elements
2064
* #7112: html: SVG image is not layouted as float even if aligned
2065
* #6906, #6907: autodoc: failed to read the source codes encoeded in cp1251
2066
* #6961: latex: warning for babel shown twice
2067
* #7059: latex: LaTeX compilation falls into infinite loop (wrapfig issue)
2068
* #6581: latex: ``:reversed:`` option for toctree does not effect to LaTeX build
2069
* #6559: Wrong node-ids are generated in glossary directive
2070
* #6986: apidoc: misdetects module name for .so file inside module
2071
* #6899: apidoc: private members are not shown even if ``--private`` given
2072
* #6327: apidoc: Support a python package consisted of __init__.so file
2073
* #6999: napoleon: fails to parse tilde in :exc: role
2074
* #7019: gettext: Absolute path used in message catalogs
2075
* #7023: autodoc: nested partial functions are not listed
2076
* #7023: autodoc: partial functions imported from other modules are listed as
2077
module members without :impoprted-members: option
2078
* #6889: autodoc: Trailing comma in ``:members::`` option causes cryptic warning
2079
* #6568: autosummary: ``autosummary_imported_members`` is ignored on generating
2080
a stub file for submodule
2081
* #7055: linkcheck: redirect is treated as an error
2082
* #7088: HTML template: If ``navigation_with_keys`` option is activated,
2083
modifier keys are ignored, which means the feature can interfere with browser
2084
features
2085
* #7090: std domain: Can't assign numfig-numbers for custom container nodes
2086
* #7106: std domain: enumerated nodes are marked as duplicated when extensions
2087
call ``note_explicit_target()``
2088
* #7095: dirhtml: Cross references are broken via intersphinx and ``:doc:`` role
2089
* C++:
2090
2091
- Don't crash when using the ``struct`` role in some cases.
2092
- Don't warn when using the ``var``/``member`` role for function
2093
parameters.
2094
- Render call and braced-init expressions correctly.
2095
* #7097: Filenames of images generated by
2096
``sphinx.transforms.post_transforms.images.ImageConverter``
2097
or its subclasses (used for latex build) are now sanitized,
2098
to prevent broken paths
2099
2100
-------------------------------------------------------------------
2101
Tue Apr 7 08:20:04 UTC 2020 - Steve Kowalik <steven.kowalik@suse.com>
2102
2103
- Revert to 2.3.1 due to severely increased memory usage when building
2104
kernel documentation. bsc#1166965
2105
2106
-------------------------------------------------------------------
2107
Sun Mar 8 18:13:36 UTC 2020 - Arun Persaud <arun@gmx.de>
2108
2109
- update to version 2.4.4:
2110
* #7197: LaTeX: platex cause error to build image directive with
2111
target url
2112
* #7223: Sphinx builds has been slower since 2.4.0
2113
2114
-------------------------------------------------------------------
2115
Sat Feb 22 18:38:16 UTC 2020 - Arun Persaud <arun@gmx.de>
2116
2117
- specfile:
2118
* update copyright year
2119
2120
- update to version 2.4.3:
2121
* Bugs fixed
2122
+ #7184: autodoc: "*args" and "**kwarg" in type comments are not
2123
handled properly
2124
+ #7189: autodoc: classmethod coroutines are not detected
2125
+ #7183: intersphinx: ":attr:" reference to property is broken
2126
+ #6244, #6387: html search: Search breaks/hangs when built with
2127
dirhtml builder
2128
+ #7195: todo: emit doctree-resolved event with non-document node
2129
incorrectly
2130
2131
- changes from version 2.4.2:
2132
* Bugs fixed
2133
+ #7138: autodoc: "autodoc.typehints" crashed when variable has
2134
unbound object as a value
2135
+ #7156: autodoc: separator for keyword only arguments is not
2136
shown
2137
+ #7146: autodoc: IndexError is raised on suppressed type_comment
2138
found
2139
+ #7161: autodoc: typehints extension does not support parallel
2140
build
2141
+ #7178: autodoc: TypeError is raised on fetching type annotations
2142
+ #7151: crashed when extension assigns a value to
2143
"env.indexentries"
2144
+ #7170: text: Remove debug print
2145
+ #7137: viewcode: Avoid to crash when non-python code given
2146
2147
- changes from version 2.4.1:
2148
* Bugs fixed
2149
+ #7120: html: crashed when on scaling SVG images which have float
2150
dimentions
2151
+ #7126: autodoc: TypeError: 'getset_descriptor' object is not
2152
iterable
2153
2154
- changes from version 2.4.0:
2155
* Deprecated
2156
+ The "decode" argument of "sphinx.pycode.ModuleAnalyzer()"
2157
+ "sphinx.directives.other.Index"
2158
+ "sphinx.environment.temp_data['gloss_entries']"
2159
+ "sphinx.environment.BuildEnvironment.indexentries"
2160
+
2161
"sphinx.environment.collectors.indexentries.IndexEntriesCollector"
2162
+ "sphinx.ext.apidoc.INITPY"
2163
+ "sphinx.ext.apidoc.shall_skip()"
2164
+ "sphinx.io.FiletypeNotFoundError"
2165
+ "sphinx.io.get_filetype()"
2166
+ "sphinx.pycode.ModuleAnalyzer.encoding"
2167
+ "sphinx.roles.Index"
2168
+ "sphinx.util.detect_encoding()"
2169
+ "sphinx.util.get_module_source()"
2170
+ "sphinx.util.inspect.Signature"
2171
+ "sphinx.util.inspect.safe_getmembers()"
2172
+ "sphinx.writers.latex.LaTeXTranslator.settings.author"
2173
+ "sphinx.writers.latex.LaTeXTranslator.settings.contentsname"
2174
+ "sphinx.writers.latex.LaTeXTranslator.settings.docclass"
2175
+ "sphinx.writers.latex.LaTeXTranslator.settings.docname"
2176
+ "sphinx.writers.latex.LaTeXTranslator.settings.title"
2177
+ "sphinx.writers.latex.ADDITIONAL_SETTINGS"
2178
+ "sphinx.writers.latex.DEFAULT_SETTINGS"
2179
+ "sphinx.writers.latex.LUALATEX_DEFAULT_FONTPKG"
2180
+ "sphinx.writers.latex.PDFLATEX_DEFAULT_FONTPKG"
2181
+ "sphinx.writers.latex.XELATEX_DEFAULT_FONTPKG"
2182
+ "sphinx.writers.latex.XELATEX_GREEK_DEFAULT_FONTPKG"
2183
* Features added
2184
+ #6910: inheritance_diagram: Make the background of diagrams
2185
transparent
2186
+ #6446: duration: Add "sphinx.ext.durations" to inspect which
2187
documents slow down the build
2188
+ #6837: LaTeX: Support a nested table
2189
+ #7115: LaTeX: Allow to override LATEXOPTS and LATEXMKOPTS via
2190
environment variable
2191
+ #6966: graphviz: Support ":class:" option
2192
+ #6696: html: ":scale:" option of image/figure directive not
2193
working for SVG images (imagesize-1.2.0 or above is required)
2194
+ #7025: html search: full text search can be disabled for
2195
individual document using ":nosearch:" file-wide metadata
2196
+ #6994: imgconverter: Support illustrator file (.ai) to .png
2197
conversion
2198
+ autodoc: Support Positional-Only Argument separator (PEP-570
2199
compliant)
2200
+ autodoc: Support type annotations for variables
2201
+ #2755: autodoc: Add new event:
2202
:event:`autodoc-before-process-signature`
2203
+ #2755: autodoc: Support type_comment style (ex. "# type: (str)
2204
-> str") annotation (python3.8+ or `typed_ast
2205
<https://github.com/python/typed_ast>`_ is required)
2206
+ #7051: autodoc: Support instance variables without defaults
2207
(PEP-526)
2208
+ #6418: autodoc: Add a new extension
2209
"sphinx.ext.autodoc.typehints". It shows typehints as object
2210
description if "autodoc_typehints = "description"" set. This
2211
is an experimental extension and it will be integrated into
2212
autodoc core in Sphinx-3.0
2213
+ SphinxTranslator now calls visitor/departure method for super
2214
node class if visitor/departure method for original node class
2215
not found
2216
+ #6418: Add new event: :event:`object-description-transform`
2217
+ py domain: :rst:dir:`py:data` and :rst:dir:`py:attribute` take
2218
new options named ":type:" and ":value:" to describe its type
2219
and initial value
2220
+ #6785: py domain: ":py:attr:" is able to refer properties again
2221
+ #6772: apidoc: Add "-q" option for quiet mode
2222
* Bugs fixed
2223
+ #6925: html: Remove redundant type="text/javascript" from
2224
<script> elements
2225
+ #7112: html: SVG image is not layouted as float even if aligned
2226
+ #6906, #6907: autodoc: failed to read the source codes encoeded
2227
in cp1251
2228
+ #6961: latex: warning for babel shown twice
2229
+ #7059: latex: LaTeX compilation falls into infinite loop
2230
(wrapfig issue)
2231
+ #6581: latex: ":reversed:" option for toctree does not effect to
2232
LaTeX build
2233
+ #6559: Wrong node-ids are generated in glossary directive
2234
+ #6986: apidoc: misdetects module name for .so file inside module
2235
+ #6899: apidoc: private members are not shown even if "--private"
2236
given
2237
+ #6327: apidoc: Support a python package consisted of __init__.so
2238
file
2239
+ #6999: napoleon: fails to parse tilde in :exc: role
2240
+ #7019: gettext: Absolute path used in message catalogs
2241
+ #7023: autodoc: nested partial functions are not listed
2242
+ #7023: autodoc: partial functions imported from other modules
2243
are listed as module members without :impoprted-members: option
2244
+ #6889: autodoc: Trailing comma in ":members::" option causes
2245
cryptic warning
2246
+ #6568: autosummary: "autosummary_imported_members" is ignored on
2247
generating a stub file for submodule
2248
+ #7055: linkcheck: redirect is treated as an error
2249
+ #7088: HTML template: If "navigation_with_keys" option is
2250
activated, modifier keys are ignored, which means the feature
2251
can interfere with browser features
2252
+ #7090: std domain: Can't assign numfig-numbers for custom
2253
container nodes
2254
+ #7106: std domain: enumerated nodes are marked as duplicated
2255
when extensions call "note_explicit_target()"
2256
+ #7095: dirhtml: Cross references are broken via intersphinx and
2257
":doc:" role
2258
+ C++:
2259
- Don't crash when using the ``struct`` role in some cases.
2260
- Don't warn when using the ``var``/``member`` role for function parameters.
2261
- Render call and braced-init expressions correctly.
2262
+ #7097: Filenames of images generated by
2263
"sphinx.transforms.post_transforms.images.ImageConverter" or
2264
its subclasses (used for latex build) are now sanitized, to
2265
prevent broken paths
2266
2267
-------------------------------------------------------------------
2268
Wed Dec 25 18:54:41 UTC 2019 - Luigi Baldoni <aloisio@gmx.com>
2269
2270
- Update to version 2.3.1
2271
* #6936: sphinx-autogen: raises AttributeError
2272
version 2.3.0:
2273
* #6742: ``end-before`` option of :rst:dir:`literalinclude`
2274
directive does not match the first line of the code block.
2275
* #1331: Change default User-Agent header to ``"Sphinx/X.Y.Z
2276
requests/X.Y.Z python/X.Y.Z"``. It can be changed via
2277
:confval:`user_agent`.
2278
* #6867: text: content of admonitions starts after a blank line
2279
* #6707: C++, support bit-fields.
2280
* #267: html: Eliminate prompt characters of doctest block
2281
from copyable text
2282
* #6548: html: Use favicon for OpenSearch if available
2283
* #6729: html theme: agogo theme now supports ``rightsidebar``
2284
option
2285
* #6780: Add PEP-561 Support
2286
* #6762: latex: Allow to load additonal LaTeX packages via
2287
``extrapackages`` key of :confval:`latex_elements`
2288
* #1331: Add new config variable: :confval:`user_agent`
2289
* #6000: LaTeX: have backslash also be an inline literal word
2290
wrap break character
2291
* #4186: LaTeX: Support upLaTeX as a new
2292
:confval:`latex_engine` (experimental)
2293
* #6812: Improve a warning message when extensions are not
2294
parallel safe
2295
* #6818: Improve Intersphinx performance for multiple remote
2296
inventories.
2297
* #2546: apidoc: .so file support
2298
* #6798: autosummary: emit ``autodoc-skip-member`` event on
2299
generating stub file
2300
* #6483: i18n: make explicit titles in toctree translatable
2301
* #6816: linkcheck: Add :confval:`linkcheck_auth` option to
2302
provide authentication information when doing ``linkcheck``
2303
builds
2304
* #6872: linkcheck: Handles HTTP 308 Permanent Redirect
2305
* #6613: html: Wrap section number in span tag
2306
* #6781: gettext: Add :confval:`gettext_last_translator' and
2307
:confval:`gettext_language_team` to customize headers of POT
2308
file
2309
2310
-------------------------------------------------------------------
2311
Sat Dec 7 17:50:25 UTC 2019 - Arun Persaud <arun@gmx.de>
2312
2313
- update to version 2.2.2:
2314
* Incompatible changes
2315
+ #6803: For security reason of python, parallel mode is disabled
2316
on macOS and Python3.8+
2317
* Bugs fixed
2318
+ #6776: LaTeX: 2019-10-01 LaTeX release breaks
2319
:file:`sphinxcyrillic.sty`
2320
+ #6815: i18n: French, Hindi, Chinese, Japanese and Korean
2321
translation messages has been broken
2322
+ #6803: parallel build causes AttributeError on macOS and
2323
Python3.8
2324
2325
-------------------------------------------------------------------
2326
Fri Nov 1 08:06:10 UTC 2019 - Tomáš Chvátal <tchvatal@suse.com>
2327
2328
- Update to 2.2.1:
2329
* #6641: LaTeX: Undefined control sequence \sphinxmaketitle
2330
* #6710: LaTeX not well configured for Greek language as main language
2331
2332
-------------------------------------------------------------------
2333
Wed Sep 11 12:06:58 UTC 2019 - Tomáš Chvátal <tchvatal@suse.com>
2334
2335
- Update 2.2.0:
2336
* apidoc: template files are renamed to ``.rst_t``
2337
* html: Field lists will be styled by grid layout
2338
* #5124: graphviz: ``:graphviz_dot:`` option is renamed to ``:layout:``
2339
* #1464: html: emit a warning if :confval:`html_static_path` and
2340
:confval:`html_extra_path` directories are inside output directory
2341
* #6514: html: Add a label to search input for accessability purposes
2342
* #5602: apidoc: Add ``--templatedir`` option
2343
* #6475: Add ``override`` argument to ``app.add_autodocumenter()``
2344
* #6310: imgmath: let :confval:`imgmath_use_preview` work also with the SVG
2345
format for images rendering inline math
2346
* #6533: LaTeX: refactor visit_enumerated_list() to use ``\sphinxsetlistlabels``
2347
* #6628: quickstart: Use ``https://docs.python.org/3/`` for default setting of
2348
:confval:`intersphinx_mapping`
2349
* #6419: sphinx-build: give reasons why rebuilded
2350
2351
-------------------------------------------------------------------
2352
Fri Aug 9 08:32:42 UTC 2019 - Dan Čermák <dcermak@suse.com>
2353
2354
- Add Sphinx translation files via %find_lang
2355
2356
-------------------------------------------------------------------
2357
Tue Jul 2 14:44:28 UTC 2019 - Tomáš Chvátal <tchvatal@suse.com>
2358
2359
- Update to 2.1.2:
2360
* #6497: custom lexers fails highlighting when syntax error
2361
* #6478, #6488: info field lists are incorrectly recognized
2362
2363
-------------------------------------------------------------------
2364
Tue Jun 11 18:01:43 UTC 2019 - Tomáš Chvátal <tchvatal@suse.com>
2365
2366
- Update to 2.1.1:
2367
* #6442: LaTeX: admonitions of note type can get separated from immediately preceding section title by pagebreak
2368
* #6448: autodoc: crashed when autodocumenting classes with __slots__ = None
2369
* #6452: autosummary: crashed when generating document of properties
2370
2371
-------------------------------------------------------------------
2372
Tue Jun 4 11:37:51 UTC 2019 - Tomáš Chvátal <tchvatal@suse.com>
2373
2374
- Update to 2.1:
2375
* Many major updates in the package
2376
* Supports only python 3.5+
2377
- Remove obsolete conditionals wrt 3.5+ only support
2378
2379
-------------------------------------------------------------------
2380
Wed Apr 10 20:43:43 UTC 2019 - Dirk Mueller <dmueller@suse.com>
2381
2382
- don't provide sphinx from test subpackage, it is for testing
2383
2384
-------------------------------------------------------------------
2385
Wed Apr 10 07:13:28 UTC 2019 - Dirk Mueller <dmueller@suse.com>
2386
2387
- fix tests to include latex/extmath tests
2388
2389
-------------------------------------------------------------------
2390
Wed Mar 27 16:39:15 UTC 2019 - Matej Cepl <mcepl@suse.com>
2391
2392
- Remove last remainder of python-Sphinx-doc-man-common subpackage
2393
2394
-------------------------------------------------------------------
2395
Thu Mar 14 16:25:50 CET 2019 - Matej Cepl <mcepl@suse.com>
2396
2397
- Switch off test_latex_images test, because it tries to download
2398
image from the www.python.org.
2399
2400
-------------------------------------------------------------------
2401
Tue Mar 12 15:35:49 UTC 2019 - Matej Cepl <mcepl@suse.com>
2402
2403
- Remove lang packages
2404
2405
-------------------------------------------------------------------
2406
Mon Mar 11 15:32:54 CET 2019 - Matej Cepl <mcepl@suse.com>
2407
2408
- Revert to multiple lang files using standard macros.
2409
2410
-------------------------------------------------------------------
2411
Mon Mar 11 10:25:50 UTC 2019 - Tomáš Chvátal <tchvatal@suse.com>
2412
2413
- Drop patch disable-test.patch no longer applicable
2414
2415
-------------------------------------------------------------------
2416
Mon Mar 11 09:40:44 UTC 2019 - Tomáš Chvátal <tchvatal@suse.com>
2417
2418
- Update to 1.8.5:
2419
* LaTeX: Remove extraneous space after author names on PDF title page (refs: #6004)
2420
* #6026: LaTeX: A cross reference to definition list does not work
2421
* #6046: LaTeX: TypeError is raised when invalid latex_elements given
2422
* #6067: LaTeX: images having a target are concatenated to next line
2423
* #6067: LaTeX: images having a target are not aligned even if specified
2424
* #6019: imgconverter: Including multipage PDF fails
2425
* #6047: autodoc: autofunction emits a warning for method objects
2426
* #6028: graphviz: Ensure the graphviz filenames are reproducible
2427
* #6068: doctest: skipif option may remove the code block from documentation
2428
* #6136: :name: option for math directive causes a crash
2429
* #6139: intersphinx: ValueError on failure reporting
2430
* #6135: changes: Fix UnboundLocalError when any module found
2431
2432
-------------------------------------------------------------------
2433
Wed Mar 6 16:28:12 CET 2019 - Matej Cepl <mcepl@suse.com>
2434
2435
- Rewrite the package to multibuild. Remove python-Sphinx-doc*.
2436
- Fix %check to make tests passing.
2437
2438
-------------------------------------------------------------------
2439
Tue Mar 5 10:17:45 UTC 2019 - Thomas Bechtold <tbechtold@suse.com>
2440
2441
- update to 1.8.4:
2442
There are many changes so have a look at the following changes files:
2443
* https://www.sphinx-doc.org/en/master/changes.html#release-1-8-4-released-feb-03-2019
2444
* https://www.sphinx-doc.org/en/master/changes.html#release-1-8-3-released-dec-26-2018
2445
* https://www.sphinx-doc.org/en/master/changes.html#release-1-8-2-released-nov-11-2018
2446
* https://www.sphinx-doc.org/en/master/changes.html#release-1-8-1-released-sep-22-2018
2447
* https://www.sphinx-doc.org/en/master/changes.html#release-1-8-0-released-sep-13-2018
2448
* https://www.sphinx-doc.org/en/master/changes.html#release-1-7-9-released-sep-05-2018
2449
* https://www.sphinx-doc.org/en/master/changes.html#release-1-7-8-released-aug-29-2018
2450
* https://www.sphinx-doc.org/en/master/changes.html#release-1-7-7-released-aug-19-2018
2451
2452
-------------------------------------------------------------------
2453
Fri Dec 7 21:20:58 CET 2018 - mcepl@suse.com
2454
2455
- Make this package also own %{python_sitelib}/sphinxcontrib
2456
directory, so it is properly owned.
2457
2458
-------------------------------------------------------------------
2459
Wed Jul 18 15:28:39 UTC 2018 - mimi.vx@gmail.com
2460
2461
- update to 1.7.6
2462
- fix Requires based on results of Shinx testsuite
2463
* LaTeX \sphinxupquote{} breaks in Russian
2464
* sphinx.testing uses deprecated pytest API; Node.get_marker(name)
2465
* crashed when recommonmark.AutoStrictify is enabled
2466
* latex: crashed with docutils package provided by Debian/Ubuntu
2467
* latex: a label for table is vanished if table does not have a caption
2468
* crashed with numbered toctree
2469
* C, render empty argument lists for macros.
2470
* C++, fix lookup of full template specializations with no template arguments.
2471
* C++, fix assertion on missing references in global scope when using intersphinx.
2472
* autodoc: crashed by Form Feed Character
2473
* autodoc: loses the first staticmethod parameter for old styled classes
2474
* quickstart: Typing Ctrl-U clears the whole of line
2475
* html: “relations” sidebar is not shown by default
2476
* latex: curly braces in index entries are not handled correctly
2477
* epub: Wrong internal href fragment links
2478
* apidoc: Interface of sphinx.apidoc:main() has changed
2479
* PDF builds of French projects have issues with XeTeX
2480
* napoleon raises RuntimeError with python 3.7
2481
* sphinx-build: Interface of sphinx:main() has changed
2482
* sphinx-build: sphinx.cmd.build.main() refers sys.argv
2483
instead of given argument
2484
* autosummary: warning is emitted when the first line of docstring ends
2485
with literal notation
2486
* autosummary: warnings of autosummary indicates wrong location (refs: #5146)
2487
* autodoc: crashed on inspecting dict like object which does not support sorting
2488
* autodoc: Enum argument missing if it shares value with another
2489
* py domain: rtype field could not handle “None” as a type
2490
* LaTeX: indexing of terms containing @, !, or " fails
2491
* html: crashes if copying static files are failed
2492
* autodoc: Fix formatting type annotations for tuples with more than two arguments
2493
* i18n: crashed by auto-symbol footnote references
2494
* autosummary: module summary has been broken when it starts with heading
2495
2496
-------------------------------------------------------------------
2497
Tue Jul 17 08:14:57 UTC 2018 - dmueller@suse.com
2498
2499
- update to 1.7.5:
2500
* #4924: html search: Upper characters problem in any other languages
2501
* #4932: apidoc: some subpackage is ignored if sibling subpackage contains a
2502
module starting with underscore
2503
* #4863, #4938, #4939: i18n doesn't handle node.title correctly tat used for
2504
contents, topic, admonition, table and section.
2505
* #4913: i18n: literal blocks in bullet list are not translated
2506
* #4962: C++, raised TypeError on duplicate declaration.
2507
* #4825: C++, properly parse expr roles and give better error messages when
2508
(escaped) line breaks are present.
2509
* C++, properly use ``desc_addname`` nodes for prefixes of names.
2510
* C++, parse pack expansions in function calls.
2511
* #4915, #4916: links on search page are broken when using dirhtml builder
2512
* #4969: autodoc: constructor method should not have return annotation
2513
* latex: deeply nested enumerated list which is beginning with non-1 causes
2514
LaTeX engine crashed
2515
* #4978: latex: shorthandoff is not set up for Brazil locale
2516
* #4928: i18n: Ignore dot-directories like .git/ in LC_MESSAGES/
2517
* #4946: py domain: type field could not handle "None" as a type
2518
* #4979: latex: Incorrect escaping of curly braces in index entries
2519
* #4956: autodoc: Failed to extract document from a subclass of the class on
2520
mocked module
2521
* #4973: latex: glossary directive adds whitespace to each item
2522
* #4980: latex: Explicit labels on code blocks are duplicated
2523
* #4919: node.asdom() crashes if toctree has :numbered: option
2524
* #4914: autodoc: Parsing error when using dataclasses without default values
2525
* #4931: autodoc: crashed when handler for autodoc-skip-member raises an error
2526
* #4931: autodoc: crashed when subclass of mocked class are processed by
2527
napoleon module
2528
* #5007: sphinx-build crashes when error log contains a "%" character
2529
2530
-------------------------------------------------------------------
2531
Wed May 23 12:14:49 UTC 2018 - mimi.vx@gmail.com
2532
2533
- update to 1.7.4
2534
- very long list of changes - please see http://www.sphinx-doc.org/en/master/changes.html#release-1-7-4-released-apr-25-2018
2535
2536
-------------------------------------------------------------------
2537
Thu Mar 8 10:22:47 UTC 2018 - aplanas@suse.com
2538
2539
- Allows Recommends and Suggest in Fedora
2540
2541
-------------------------------------------------------------------
2542
Tue Mar 6 11:55:15 UTC 2018 - dmueller@suse.com
2543
2544
- go back to a working sphinx version for now (1.6.5)
2545
* newer versions are not able to build openstack clients
2546
2547
-------------------------------------------------------------------
2548
Tue Feb 27 14:09:37 UTC 2018 - aplanas@suse.com
2549
2550
- Recommends only on SUSE
2551
2552
-------------------------------------------------------------------
2553
Sat Feb 24 18:31:35 UTC 2018 - arun@gmx.de
2554
2555
- specfile:
2556
* update copyright year
2557
* remove sed for sed command for sphinx/pycode/pgen2/token.py
2558
(not in tar-ball anymore)
2559
2560
- update to version 1.7.1:
2561
* Deprecated
2562
+ #4623: "sphinx.build_main()" is deprecated. Use
2563
"sphinx.cmd.build.build_main()" instead.
2564
+ autosummary: The interface of
2565
"sphinx.ext.autosummary.get_documenter()" has been changed
2566
(Since 1.7.0)
2567
+ #4664: "sphinx.ext.intersphinx.debug()" is deprecated. Use
2568
"sphinx.ext.intersphinx.inspect_main()" instead.
2569
* Bugs fixed
2570
+ #4608: epub: Invalid meta tag is generated
2571
+ #4260: autodoc: keyword only argument separator is not
2572
disappeared if it is appeared at top of the argument list
2573
+ #4622: epub: :confval:`epub_scheme` does not effect to
2574
content.opf
2575
+ #4627: graphviz: Fit graphviz images to page
2576
+ #4617: quickstart: PROJECT_DIR argument is required
2577
+ #4623: sphinx.build_main no longer exists in 1.7.0
2578
+ #4615: The argument of "sphinx.build" has been changed in 1.7.0
2579
+ autosummary: The interface of
2580
"sphinx.ext.autosummary.get_documenter()" has been changed
2581
+ #4630: Have order on msgids in sphinx.pot deterministic
2582
+ #4563: autosummary: Incorrect end of line punctuation detection
2583
+ #4577: Enumerated sublists with explicit start with wrong number
2584
+ #4641: A external link in TOC cannot contain "?" with ":glob:"
2585
option
2586
+ C++, add missing parsing of explicit casts and typeid in
2587
expression parsing.
2588
+ C++, add missing parsing of "this" in expression parsing.
2589
+ #4655: Fix incomplete localization strings in Polish
2590
+ #4653: Fix error reporting for parameterless ImportErrors
2591
+ #4664: Reading objects.inv fails again
2592
+ #4662: "any" refs with "term" targets crash when an ambiguity is
2593
encountered
2594
2595
- changes to version 1.7.0:
2596
* long changelog, see https://github.com/sphinx-doc/sphinx/blob/master/CHANGES
2597
2598
- changes from version 1.6.7:
2599
* Bugs fixed
2600
+ #1922: html search: Upper characters problem in French
2601
+ #4412: Updated jQuery version from 3.1.0 to 3.2.1
2602
+ #4438: math: math with labels with whitespace cause html error
2603
+ #2437: make full reference for classes, aliased with "alias of"
2604
+ #4434: pure numbers as link targets produce warning
2605
+ #4477: Build fails after building specific files
2606
+ #4449: apidoc: include "empty" packages that contain modules
2607
+ #3917: citation labels are tranformed to ellipsis
2608
+ #4501: graphviz: epub3 validation error caused if graph is not
2609
clickable
2610
+ #4514: graphviz: workaround for wrong map ID which graphviz
2611
generates
2612
+ #4525: autosectionlabel does not support parallel build
2613
+ #3953: Do not raise warning when there is a working intersphinx
2614
inventory
2615
+ #4487: math: ValueError is raised on parallel build. Thanks to
2616
jschueller.
2617
+ #2372: autosummary: invalid signatures are shown for type
2618
annotated functions
2619
+ #3942: html: table is not aligned to center even if ":align:
2620
center"
2621
2622
- changes from version 1.6.6:
2623
* Features added
2624
+ #4181: autodoc: Sort dictionary keys when possible
2625
+ "VerbatimHighlightColor" is a new :ref:`LaTeX 'sphinxsetup'
2626
<latexsphinxsetup>` key (refs: #4285)
2627
+ Easier customizability of LaTeX macros involved in rendering of
2628
code-blocks
2629
+ Show traceback if conf.py raises an exception (refs: #4369)
2630
+ Add :confval:`smartquotes` to disable smart quotes through
2631
"conf.py" (refs: #3967)
2632
+ Add :confval:`smartquotes_action` and
2633
:confval:`smartquotes_excludes` (refs: #4142, #4357)
2634
* Bugs fixed
2635
+ #4334: sphinx-apidoc: Don't generate references to non-existing
2636
files in TOC
2637
+ #4206: latex: reST label between paragraphs loses paragraph
2638
break
2639
+ #4231: html: Apply fixFirefoxAnchorBug only under Firefox
2640
+ #4221: napoleon depends on autodoc, but users need to load it
2641
manually
2642
+ #2298: automodule fails to document a class attribute
2643
+ #4099: C++: properly link class reference to class from inside
2644
constructor
2645
+ #4267: PDF build broken by Unicode U+2116 NUMERO SIGN character
2646
+ #4249: PDF output: Pygments error highlighting increases line
2647
spacing in code blocks
2648
+ #1238: Support ":emphasize-lines:" in PDF output
2649
+ #4279: Sphinx crashes with pickling error when run with multiple
2650
processes and remote image
2651
+ #1421: Respect the quiet flag in sphinx-quickstart
2652
+ #4281: Race conditions when creating output directory
2653
+ #4315: For PDF 'howto' documents,
2654
"latex_toplevel_sectioning='part'" generates "\chapter"
2655
commands
2656
+ #4214: Two todolist directives break sphinx-1.6.5
2657
+ Fix links to external option docs with intersphinx (refs: #3769)
2658
+ #4091: Private members not documented without :undoc-members:
2659
2660
-------------------------------------------------------------------
2661
Fri Oct 27 16:13:16 UTC 2017 - arun@gmx.de
2662
2663
- update to version 1.6.5:
2664
* Features added
2665
+ #4107: Make searchtools.js compatible with pre-Sphinx1.5
2666
templates
2667
+ #4112: Don't override the smart_quotes setting if it was already
2668
set
2669
+ #4125: Display reference texts of original and translated
2670
passages on i18n warning message
2671
+ #4147: Include the exception when logging PO/MO file read/write
2672
* Bugs fixed
2673
+ #4085: Failed PDF build from image in parsed-literal using
2674
":align:" option
2675
+ #4100: Remove debug print from autodoc extension
2676
+ #3987: Changing theme from alabaster causes HTML build to fail
2677
+ #4096: C++, don't crash when using the wrong role type. Thanks
2678
to mitya57.
2679
+ #4070, #4111: crashes when the warning message contains format
2680
strings (again)
2681
+ #4108: Search word highlighting breaks SVG images
2682
+ #3692: Unable to build HTML if writing .buildinfo failed
2683
+ #4152: HTML writer crashes if a field list is placed on top of
2684
the document
2685
+ #4063: Sphinx crashes when labeling directive ".. todolist::"
2686
+ #4134: [doc] :file:`docutils.conf` is not documented explicitly
2687
+ #4169: Chinese language doesn't trigger Chinese search
2688
automatically
2689
+ #1020: ext.todo todolist not linking to the page in pdflatex
2690
+ #3965: New quickstart generates wrong SPHINXBUILD in Makefile
2691
+ #3739: ":module:" option is ignored at content of pyobjects
2692
+ #4149: Documentation: Help choosing :confval:`latex_engine`
2693
+ #4090: [doc] :confval:`latex_additional_files` with extra LaTeX
2694
macros should not use ".tex" extension
2695
+ Failed to convert reST parser error to warning (refs: #4132)
2696
2697
-------------------------------------------------------------------
2698
Sat Sep 30 16:28:00 UTC 2017 - arun@gmx.de
2699
2700
- update to version 1.6.4:
2701
* Features added
2702
+ #3926: Add "autodoc_warningiserror" to suppress the behavior of
2703
"-W" option during importing target modules on autodoc
2704
* Bugs fixed
2705
+ #3924: docname lost after dynamically parsing RST in extension
2706
+ #3946: Typo in sphinx.sty (this was a bug with no effect in
2707
default context)
2708
+ :pep: and :rfc: does not supports "default-role" directive
2709
(refs: #3960)
2710
+ #3960: default_role = 'guilabel' not functioning
2711
+ Missing "texinputs_win/Makefile" to be used in latexpdf builder
2712
on windows.
2713
+ #4026: nature: Fix macOS Safari scrollbar color
2714
+ #3877: Fix for C++ multiline signatures.
2715
+ #4006: Fix crash on parallel build
2716
+ #3969: private instance attributes causes AttributeError
2717
+ #4041: C++, remove extra name linking in function pointers.
2718
+ #4038: C, add missing documentation of "member" role.
2719
+ #4044: An empty multicolumn cell causes extra row height in PDF
2720
output
2721
+ #4049: Fix typo in output of sphinx-build -h
2722
+ #4062: hashlib.sha1() must take bytes, not unicode on Python 3
2723
+ Avoid indent after index entries in latex (refs: #4066)
2724
+ #4070: crashes when the warning message contains format strings
2725
+ #4067: Return non-zero exit status when make subprocess fails
2726
+ #4055: graphviz: the :align: option does not work for SVG output
2727
+ #4055: graphviz: the :align: center option does not work for
2728
latex output
2729
+ #4051: "warn()" function for HTML theme outputs 'None' string
2730
2731
-------------------------------------------------------------------
2732
Mon Sep 18 22:03:24 UTC 2017 - toddrme2178@gmail.com
2733
2734
- Move sphinxcontrib namespace into seperate package to avoid
2735
dependency loop with sphinxcontrib-websupport.
2736
2737
-------------------------------------------------------------------
2738
Mon Sep 11 17:07:40 UTC 2017 - jengelh@inai.de
2739
2740
- Trim package descriptions for size.
2741
2742
-------------------------------------------------------------------
2743
Thu Aug 31 22:47:36 UTC 2017 - toddrme2178@gmail.com
2744
2745
- Create a base sphinxcontrib namespace package to guarantee all
2746
the "python(2|3)-sphinxcontrib-foo" packages can be imported
2747
correctly.
2748
2749
-------------------------------------------------------------------
2750
Thu Aug 24 15:55:01 UTC 2017 - toddrme2178@gmail.com
2751
2752
- Add new latex dependencies needed in openSUSE:Factory
2753
2754
-------------------------------------------------------------------
2755
Mon Jul 24 19:11:52 UTC 2017 - toddrme2178@gmail.com
2756
2757
- Split documentation into subpackage to avoid dependency loops.
2758
- Only require python3-typing for python3 < 3.5
2759
2760
-------------------------------------------------------------------
2761
Mon Jul 3 13:45:38 UTC 2017 - tbechtold@suse.com
2762
2763
- update to 1.6.3:
2764
* #3821: Failed to import sphinx.util.compat with docutils-0.14rc1
2765
* #3829: sphinx-quickstart template is incomplete regarding use of alabaster
2766
* #3772: 'str object' has no attribute 'filename'
2767
* Emit wrong warnings if citation label includes hyphens (refs: #3565)
2768
* #3858: Some warnings are not colored when using --color option
2769
* #3775: Remove unwanted whitespace in default template
2770
* #3835: sphinx.ext.imgmath fails to convert SVG images if project directory
2771
name contains spaces
2772
* #3850: Fix color handling in make mode's help command
2773
* #3865: use of self.env.warn in sphinx extension fails
2774
* #3824: production lists apply smart quotes transform since Sphinx 1.6.1
2775
* latex: fix ``\sphinxbfcode`` swallows initial space of argument
2776
* #3878: Quotes in auto-documented class attributes should be straight quotes
2777
in PDF output
2778
* #3881: LaTeX figure floated to next page sometimes leaves extra vertical
2779
whitespace
2780
* #3885: duplicated footnotes raises IndexError
2781
* #3873: Failure of deprecation warning mechanism of
2782
``sphinx.util.compat.Directive``
2783
* #3874: Bogus warnings for "citation not referenced" for cross-file citations
2784
* #3860: Don't download images when builders not supported images
2785
* #3860: Remote image URIs without filename break builders not supported remote
2786
images
2787
* #3833: command line messages are translated unintentionally with ``language``
2788
setting.
2789
* #3840: make checking ``epub_uid`` strict
2790
* #3851, #3706: Fix about box drawing characters for PDF output
2791
* #3900: autosummary could not find methods
2792
* #3902: Emit error if ``latex_documents`` contains non-unicode string in py2
2793
2794
-------------------------------------------------------------------
2795
Fri Jun 30 06:54:21 UTC 2017 - tbechtold@suse.com
2796
2797
- python-sphinxcontrib-websupport is a Requires
2798
2799
-------------------------------------------------------------------
2800
Thu Jun 29 15:44:02 UTC 2017 - tbechtold@suse.com
2801
2802
- Adjust Requires
2803
2804
-------------------------------------------------------------------
2805
Fri Jun 23 18:04:59 UTC 2017 - tbechtold@suse.com
2806
2807
- update to 1.6.2:
2808
* See http://www.sphinx-doc.org/en/stable/changes.html
2809
- Adjust Requires and BuildRequires
2810
- Add disable-test.patch to disable test which needs remote access.
2811
2812
-------------------------------------------------------------------
2813
Mon May 8 15:38:53 UTC 2017 - toddrme2178@gmail.com
2814
2815
- Fix update-alternatives.
2816
2817
-------------------------------------------------------------------
2818
Fri May 5 14:55:31 UTC 2017 - toddrme2178@gmail.com
2819
2820
- Fix old obsoletes/provides.
2821
2822
-------------------------------------------------------------------
2823
Mon Feb 20 14:18:17 UTC 2017 - jmatejek@suse.com
2824
2825
- update for singlespec
2826
- run tests for all python versions
2827
- include python-enum34 for test compatibility
2828
2829
-------------------------------------------------------------------
2830
Thu Feb 16 11:18:38 UTC 2017 - tbechtold@suse.com
2831
2832
- update to 1.5.2:
2833
* See http://www.sphinx-doc.org/en/stable/changes.html
2834
- Adjust Requires and BuildRequires
2835
2836
-------------------------------------------------------------------
2837
Mon Feb 29 16:07:44 UTC 2016 - michael@stroeder.com
2838
2839
- Removed obsolete fix_some_testcase_error_with_pygments-2.1.1.patch
2840
- update to version 1.3.6:
2841
* #1873, #1876, #2278: Add ``page_source_suffix`` html context variable. This should be
2842
introduced with :confval:`source_parsers` feature. Thanks for Eric Holscher.
2843
* #2265: Fix babel is used in spite of disabling it on ``latex_elements``
2844
* #2295: Avoid mutating dictionary errors while enumerating members in autodoc
2845
with Python 3
2846
* #2291: Fix pdflatex "Counter too large" error from footnotes inside tables of contents
2847
* #2292: Fix some footnotes disappear from LaTeX output
2848
* #2287: ``sphinx.transforms.Locale`` always uses rst parser. Sphinx i18n feature should
2849
support parsers that specified source_parsers.
2850
* #2290: Fix ``sphinx.ext.mathbase`` use of amsfonts may break user choice of math fonts
2851
* #2324: Print a hint how to increase the recursion limit when it is hit.
2852
* #1565, #2229: Revert new warning; the new warning will be triggered from version 1.4 on.
2853
* #2329: Refresh environment forcely if source directory has changed.
2854
* #2019: Fix the domain objects in search result are not escaped
2855
2856
-------------------------------------------------------------------
2857
Wed Feb 17 09:10:17 UTC 2016 - toddrme2178@gmail.com
2858
2859
- Add fix_some_testcase_error_with_pygments-2.1.1.patch
2860
Fixes tests with python-Pygments 2.1.1.
2861
Should be in next release.
2862
See https://github.com/sphinx-doc/sphinx/commit/50f4862b069d58ade556aad90bd179206f10fdc1
2863
- Add additional latex requirements.
2864
2865
-------------------------------------------------------------------
2866
Mon Jan 25 10:56:43 UTC 2016 - michael@stroeder.com
2867
2868
- requires python-pygments => 2.1
2869
- update to version 1.3.5:
2870
* Fix line numbers was not shown on warnings in LaTeX and texinfo
2871
builders
2872
* Fix filenames were not shown on warnings of citations
2873
* Fix line numbers was not shown on warnings in LaTeX and texinfo
2874
builders
2875
* Fix line numbers was not shown on warnings of indecies
2876
* #2026: Fix LaTeX builder rais error if parsed-literal includes
2877
links
2878
* #2243: Ignore strange docstring types for classes, do not crash
2879
* #2247: Fix #2205 breaks make html for definition list with
2880
classifiers that contains regular-expression like string
2881
* #1565: Show warning if Pygments throws an ErrorToken
2882
* #2211: Fix paragraphs in table cell doesn't work in Latex output
2883
* #2253: ":pyobject:" option of "literalinclude" directive can't
2884
detect indented body block when the block starts with blank or
2885
comment lines.
2886
* Fix TOC is not shown when no ":maxdepth:" for toctrees (ref: #771)
2887
* Fix warning message for ":numref:" if target is in orphaned doc
2888
(ref: #2244)
2889
2890
-------------------------------------------------------------------
2891
Tue Jan 12 16:35:16 UTC 2016 - michael@stroeder.com
2892
2893
- Update to 1.3.4
2894
2895
Release 1.3.4 (released Jan 12, 2016)[51]
2896
* #2134: Fix figure caption with reference causes latex build error
2897
* #2094: Fix rubric with reference not working in Latex
2898
* #2147: Fix litralinclude code in latex does not break in pages
2899
* #1833: Fix email addresses is showed again if latex_show_urls is
2900
not None
2901
* #2176: sphinx.ext.graphviz: use <object> instead of <img> to embed
2902
svg
2903
* #967: Fix SVG inheritance diagram is not hyperlinked (clickable)
2904
* #1237: Fix footnotes not working in definition list in LaTeX
2905
* #2168: Fix raw directive does not work for text writer
2906
* #2171: Fix cannot linkcheck url with unicode
2907
* #2182: LaTeX: support image file names with more than 1 dots
2908
* #2189: Fix previous sibling link for first file in subdirectory
2909
uses last file, not intended previous from root toctree
2910
* #2003: Fix decode error under python2 (only) when make linkcheck is
2911
run
2912
* #2186: Fix LaTeX output of mathbb in math
2913
* #1480, #2188: LaTeX: Support math in section titles
2914
* #2071: Fix same footnote in more than two section titles =>
2915
LaTeX/PDF Bug
2916
* #2040: Fix UnicodeDecodeError in sphinx-apidoc when author contains
2917
non-ascii characters
2918
* #2193: Fix shutil.SameFileError if source directory and destination
2919
directory are same
2920
* #2178: Fix unparseable C++ cross-reference when referencing a
2921
function with :cpp:any:
2922
* #2206: Fix Sphinx latex doc build failed due to a footnotes
2923
* #2201: Fix wrong table caption for tables with over 30 rows
2924
* #2213: Set <blockquote> in the classic theme to fit with <p>
2925
* #1815: Fix linkcheck does not raise an exception if warniserror set
2926
to true and link is broken
2927
* #2197: Fix slightly cryptic error message for missing index.rst
2928
file
2929
* #1894: Unlisted phony targets in quickstart Makefile
2930
* #2125: Fix unifies behavior of collapsed fields (GroupedField and
2931
TypedField)
2932
* #1408: Check latex_logo validity before copying
2933
* #771: Fix latex output doesn’t set tocdepth
2934
* #1820: On Windows, console coloring is broken with colorama version
2935
0.3.3. Now sphinx use colorama>=0.3.5 to avoid this problem.
2936
* #2072: Fix footnotes in chapter-titles do not appear in PDF output
2937
* #1580: Fix paragraphs in longtable don’t work in Latex output
2938
* #1366: Fix centered image not centered in latex
2939
* #1860: Fix man page using :samp: with braces - font doesn’t reset
2940
* #1610: Sphinx crashes in japanese indexing in some systems
2941
* Fix Sphinx crashes if mecab initialization failed
2942
* #2160: Fix broken TOC of PDFs if section includes an image
2943
* #2172: Fix dysfunctional admonition [53]py@lightbox in sphinx.sty.
2944
Thanks to jfbu.
2945
* #2198,#2205: make gettext generate broken msgid for definition
2946
lists.
2947
* #2062: Escape characters in doctests are treated incorrectly with
2948
Python 2.
2949
* #2225: Fix if the option does not begin with dash, linking is not
2950
performed
2951
* #2226: Fix math is not HTML-encoded when :nowrap: is given (jsmath,
2952
mathjax)
2953
* #1601, #2220: ‘any’ role breaks extended domains behavior. Affected
2954
extensions doesn’t support resolve_any_xref and resolve_xref
2955
returns problematic node instead of None. sphinxcontrib-httpdomain
2956
is one of them.
2957
* #2229: Fix no warning is given for unknown options
2958
2959
-------------------------------------------------------------------
2960
Wed Dec 9 16:41:19 UTC 2015 - michael@stroeder.com
2961
2962
- Update to 1.3.3
2963
- Updated project url in .spec file
2964
- Aligned version in BuildRequires: python-Pygments >= 2.0 with
2965
Requires line
2966
2967
Release 1.3.3 (released Dec 2, 2015)
2968
====================================
2969
2970
Bugs fixed
2971
----------
2972
2973
* #2012: Fix exception occurred if ``numfig_format`` is invalid
2974
* #2142: Provide non-minified JS code in ``sphinx/search/non-minified-js/*.js`` for
2975
source distribution on PyPI.
2976
* #2148: Error while building devhelp target with non-ASCII document.
2977
2978
2979
Release 1.3.2 (released Nov 29, 2015)
2980
=====================================
2981
2982
Features added
2983
--------------
2984
2985
* #1935: Make "numfig_format" overridable in latex_elements.
2986
2987
Bugs fixed
2988
----------
2989
2990
* #1976: Avoid "2.0" version of Babel because it doesn't work with Windows environment.
2991
* Add a "default.css" stylesheet (which imports "classic.css") for compatibility.
2992
* #1788: graphviz extension raises exception when caption option is present.
2993
* #1789: ``:pyobject:`` option of ``literalinclude`` directive includes following
2994
lines after class definitions
2995
* #1790: ``literalinclude`` strips empty lines at the head and tail
2996
* #1802: load plugin themes automatically when theme.conf use it as 'inherit'. Thanks to
2997
Takayuki Hirai.
2998
* #1794: custom theme extended from alabaster or sphinx_rtd_theme can't find base theme.
2999
* #1834: compatibility for docutils-0.13: handle_io_errors keyword argument for
3000
docutils.io.FileInput cause TypeError.
3001
* #1823: '.' as <module_path> for sphinx-apidoc cause an unfriendly error. Now '.'
3002
is converted to absolute path automatically.
3003
* Fix a crash when setting up extensions which do not support metadata.
3004
* #1784: Provide non-minified JS code in ``sphinx/search/non-minified-js/*.js``
3005
* #1822, #1892: Fix regression for #1061. autosummary can't generate doc for imported
3006
members since sphinx-1.3b3. Thanks to Eric Larson.
3007
* #1793, #1819: "see also" misses a linebreak in text output. Thanks to Takayuki Hirai.
3008
* #1780, #1866: "make text" shows "class" keyword twice. Thanks to Takayuki
3009
Hirai.
3010
* #1871: Fix for LaTeX output of tables with one column and multirows.
3011
* Work around the lack of the HTMLParserError exception in Python 3.5.
3012
* #1949: Use ``safe_getattr`` in the coverage builder to avoid aborting with
3013
descriptors that have custom behavior.
3014
* #1915: Do not generate smart quotes in doc field type annotations.
3015
* #1796: On py3, automated .mo building caused UnicodeDecodeError.
3016
* #1923: Use babel features only if the babel latex element is nonempty.
3017
* #1942: Fix a KeyError in websupport.
3018
* #1903: Fix strange id generation for glossary terms.
3019
* #1796, On py3, automated .mo building cause UnicodeDecodeError
3020
* Fix: ``make text`` will crush if a definition list item has more than 1 classifiers as:
3021
* #1796: On py3, automated .mo building cause UnicodeDecodeError
3022
* ``make text`` will crush if a definition list item has more than 1 classifiers as:
3023
* Fixed #1855: make gettext generates broken po file for definition lists with classifier.
3024
``term : classifier1 : classifier2``.
3025
* #1855: make gettext generates broken po file for definition lists with classifier.
3026
* #1869: Fix problems when dealing with files containing non-ASCII characters. Thanks to
3027
Marvin Schmidt.
3028
* #1798: Fix building LaTeX with references in titles.
3029
* #1725: On py2 environment, doctest with using non-ASCII characters causes
3030
``'ascii' codec can't decode byte`` exception.
3031
* #1540: Fix RuntimeError with circular referenced toctree
3032
* #1983: i18n translation feature breaks references which uses section name.
3033
* #1990: Use caption of toctree to title of \tableofcontents in LaTeX
3034
* #1987: Fix ampersand is ignored in ``:menuselection:`` and ``:guilabel:`` on LaTeX builder
3035
* #1994: More supporting non-standard parser (like recommonmark parser) for Translation and
3036
WebSupport feature. Now node.rawsource is fall backed to node.astext() during docutils
3037
transforming.
3038
* On Py2 environment, conf.py that is generated by sphinx-quickstart should have u prefixed
3039
config value for 'version' and 'release'.
3040
* #2102: On Windows + Py3, using ``|today|`` and non-ASCII date format will raise
3041
UnicodeEncodeError.
3042
* #1974: UnboundLocalError: local variable 'domain' referenced before assignment when
3043
using `any` role and `sphinx.ext.intersphinx` in same time.
3044
* #2121: multiple words search doesn't find pages when words across on the page title and
3045
the page content.
3046
* #1884, #1885: plug-in html themes cannot inherit another plug-in theme. Thanks to
3047
Suzumizaki.
3048
* #1818: `sphinx.ext.todo` directive generates broken html class attribute as
3049
'admonition-' when :confval:`language` is specified with non-ASCII linguistic area like
3050
'ru' or 'ja'. To fix this, now ``todo`` directive can use ```:class:`` option.
3051
* #2140: Fix footnotes in table has broken in LaTeX
3052
* #2127: MecabBinder for html searching feature doesn't work with Python 3.
3053
Thanks to Tomoko Uchida.
3054
3055
-------------------------------------------------------------------
3056
Wed Sep 16 13:16:01 UTC 2015 - toddrme2178@gmail.com
3057
3058
- Don't buildrequires latex-related stuff.
3059
3060
-------------------------------------------------------------------
3061
Fri Sep 4 13:27:51 UTC 2015 - toddrme2178@gmail.com
3062
3063
- Split latex-related stuff into its own subpackage so we can
3064
depend on the necessary latex components.
3065
3066
-------------------------------------------------------------------
3067
Wed Jul 29 13:18:28 UTC 2015 - hpj@urpla.net
3068
3069
- Be explicit about six version requirements
3070
3071
-------------------------------------------------------------------
3072
Mon Jul 27 09:03:41 UTC 2015 - seife+obs@b1-systems.com
3073
3074
- fix build on CentOS/RHEL by conditionalizing Recommends: tag
3075
- add #!BuildIgnore: texinfo to work around CentOS-7 project config
3076
3077
-------------------------------------------------------------------
3078
Mon Jun 29 14:07:26 UTC 2015 - toddrme2178@gmail.com
3079
3080
- Fix directory for man update-alternatives
3081
- Suggests are poorly-supported in openSUSE so use Recommends
3082
3083
-------------------------------------------------------------------
3084
Mon Apr 13 17:17:57 UTC 2015 - alarrosa@suse.com
3085
3086
- Added python-six as a requirement, not only as build requirement
3087
3088
-------------------------------------------------------------------
3089
Thu Apr 9 02:29:40 UTC 2015 - termim@gmail.com
3090
3091
- Update to 1.3.1
3092
+ Bugs fixed
3093
* see http://sphinx-doc.org/changes.html#release-1-3-1-released-mar-17-2015
3094
for complete list of fixed bugs
3095
3096
- additional dependencies required by 1.3.1
3097
+ python-Babel
3098
+ python-alabaster
3099
+ python-snowballstemmer
3100
+ python-sphinx_rtdtheme
3101
+ python-mock
3102
+ python-six
3103
3104
- Update to 1.3
3105
+ Incompatible changes
3106
* Roles ref, term and menusel now don’t generate emphasis nodes
3107
anymore. If you want to keep italic style, adapt your stylesheet.
3108
* Role numref uses %s as special character to indicate position of
3109
figure numbers instead # symbol.
3110
* Dependency requirement updates: docutils 0.11, Pygments 2.0
3111
* The gettext_enables config value has been renamed to
3112
gettext_additional_targets.
3113
* #1735: Use https://doc.python.org/ instead of http protocol. It was
3114
used for sphinx.ext.intersphinx and some documentation.
3115
* update bundled ez_setup.py for setuptools-7.0 that requires Python
3116
2.6 or later.
3117
* Dropped support for Python 2.5, 3.1 and 3.2.
3118
* Dropped support for docutils versions up to 0.9.
3119
* Removed the sphinx.ext.oldcmarkup extension.
3120
* The deprecated config values exclude_trees, exclude_dirnames and
3121
unused_docs have been removed.
3122
* A new node, sphinx.addnodes.literal_strong, has been added, for text
3123
that should appear literally (i.e. no smart quotes) in strong
3124
font. Custom writers will have to be adapted to handle this node.
3125
* PR#269, #1476: replace <tt> tag by <code>. User customized
3126
stylesheets should be updated If the css contain some styles for tt>
3127
tag. Thanks to Takeshi Komiya.
3128
* #1543: templates_path is automatically added to exclude_patterns to
3129
avoid reading autosummary rst templates in the templates directory.
3130
* Custom domains should implement the new Domain.resolve_any_xref
3131
method to make the any role work properly.
3132
* gettext builder: gettext doesn’t emit uuid information to generated
3133
pot files by default. Please set True to gettext_uuid to emit uuid
3134
information. Additionally, if the python-levenshtein 3rd-party package is
3135
installed, it will improve the calculation time.
3136
* gettext builder: disable extracting/apply ‘index’ node by
3137
default. Please set ‘index’ to gettext_enables to enable extracting index
3138
entries.
3139
* PR#307: Add frame to code-block in LaTeX. Thanks to Takeshi Komiya.
3140
+ Features added
3141
* Add convenience directives and roles to the C++ domain: directive
3142
cpp:var as alias for cpp:member, role :cpp:var as alias for :cpp:member,
3143
and role any for cross-reference to any C++ declaraction. #1577, #1744
3144
* The source_suffix config value can now be a list of multiple suffixes.
3145
* Add the ability to specify source parsers by source suffix with the
3146
source_parsers config value.
3147
* #1675: A new builder, AppleHelpBuilder, has been added that builds
3148
Apple Help Books.
3149
* #1346: Add new default theme;
3150
Add ‘alabaster’ theme.
3151
Add ‘sphinx_rtd_theme’ theme.
3152
The ‘default’ html theme has been renamed to ‘classic’. ‘default’
3153
is still available, however it will emit notice a recommendation that
3154
using new ‘alabaster’ theme.
3155
* Added highlight_options configuration value.
3156
* The language config value is now available in the HTML templates.
3157
* The env-updated event can now return a value, which is interpreted as
3158
an iterable of additional docnames that need to be rewritten.
3159
* #772: Support for scoped and unscoped enums in C++. Enumerators in
3160
unscoped enums are injected into the parent scope in addition to the enum
3161
scope.
3162
* Add todo_include_todos config option to quickstart conf file, handled
3163
as described in documentation.
3164
* HTML breadcrumb items tag has class “nav-item” and “nav-item-N” (like
3165
nav-item-0, 1, 2...).
3166
* New option sphinx-quickstart --use-make-mode for generating Makefile
3167
that use sphinx-build make-mode.
3168
* #1235: i18n: several node can be translated if it is set to
3169
gettext_additional_targets in conf.py. Supported nodes are:
3170
‘literal-block’
3171
‘doctest-block’
3172
‘raw’
3173
‘image’
3174
* #1227: Add html_scaled_image_link config option to conf.py, to
3175
control scaled image link.
3176
* #1597: Added possibility to return a new template name from
3177
html-page-context.
3178
* PR#314, #1150: Configuration values are now checked for their type. A
3179
warning is raised if the configured and the default value do not have the
3180
same type and do not share a common non-trivial base class.
3181
* Add support for Python 3.4.
3182
* Add support for docutils 0.12
3183
* Added sphinx.ext.napoleon extension for NumPy and Google style
3184
docstring support.
3185
* Added support for parallel reading (parsing) of source files with the
3186
sphinx-build -j option. Third-party extensions will need to be checked
3187
for compatibility and may need to be adapted if they store information in
3188
the build environment object. See env-merge-info.
3189
* Added the any role that can be used to find a cross-reference of any
3190
type in any domain. Custom domains should implement the new
3191
Domain.resolve_any_xref method to make this work properly.
3192
* Exception logs now contain the last 10 messages emitted by Sphinx.
3193
* Added support for extension versions (a string returned by setup(),
3194
these can be shown in the traceback log files). Version requirements for
3195
extensions can be specified in projects using the new needs_extensions
3196
config value.
3197
* Changing the default role within a document with the default-role
3198
directive is now supported.
3199
* PR#214: Added stemming support for 14 languages, so that the built-in
3200
document search can now handle these. Thanks to Shibukawa Yoshiki.
3201
* PR#296, PR#303, #76: numfig feature: Assign numbers to figures,
3202
tables and code-blocks. This feature is configured with numfig,
3203
numfig_secnum_depth and numfig_format. Also numref role is
3204
available. Thanks to Takeshi Komiya.
3205
* PR#202: Allow ”.” and “~” prefixed references in :param: doc fields
3206
for Python.
3207
* PR#184: Add autodoc_mock_imports, allowing to mock imports of
3208
external modules that need not be present when autodocumenting.
3209
* #925: Allow list-typed config values to be provided on the command
3210
line, like -D key=val1,val2.
3211
* #668: Allow line numbering of code-block and literalinclude
3212
directives to start at an arbitrary line number, with a new lineno-start
3213
option.
3214
* PR#172, PR#266: The code-block and literalinclude directives now can
3215
have a caption option that shows a filename before the code in the
3216
output. Thanks to Nasimul Haque, Takeshi Komiya.
3217
* Prompt for the document language in sphinx-quickstart.
3218
* PR#217: Added config values to suppress UUID and location information
3219
in generated gettext catalogs.
3220
* PR#236, #1456: apidoc: Add a -M option to put module documentation
3221
before submodule documentation. Thanks to Wes Turner and Luc Saffre.
3222
* #1434: Provide non-minified JS files for jquery.js and underscore.js
3223
to clarify the source of the minified files.
3224
* PR#252, #1291: Windows color console support. Thanks to meu31.
3225
* PR#255: When generating latex references, also insert latex
3226
target/anchor for the ids defined on the node. Thanks to Olivier
3227
Heurtier.
3228
* PR#229: Allow registration of other translators. Thanks to Russell
3229
Sim.
3230
* Add app.set_translator() API to register or override a Docutils
3231
translator class like html_translator_class.
3232
* PR#267, #1134: add ‘diff’ parameter to literalinclude. Thanks to
3233
Richard Wall and WAKAYAMA shirou.
3234
* PR#272: Added ‘bizstyle’ theme. Thanks to Shoji KUMAGAI.
3235
* Automatically compile *.mo files from *.po files when
3236
gettext_auto_build is True (default) and *.po is newer than *.mo file.
3237
* #623: sphinx.ext.viewcode supports imported function/class aliases.
3238
* PR#275: sphinx.ext.intersphinx supports multiple target for the
3239
inventory. Thanks to Brigitta Sipocz.
3240
* PR#261: Added the env-before-read-docs event that can be connected to
3241
modify the order of documents before they are read by the environment.
3242
* #1284: Program options documented with option can now start with +.
3243
* PR#291: The caption of code-block is recognised as a title of ref
3244
target. Thanks to Takeshi Komiya.
3245
* PR#298: Add new API: add_latex_package(). Thanks to Takeshi Komiya.
3246
* #1344: add gettext_enables to enable extracting ‘index’ to gettext
3247
catalog output / applying translation catalog to generated
3248
documentation.
3249
* PR#301, #1583: Allow the line numbering of the directive
3250
literalinclude to match that of the included file, using a new
3251
lineno-match option. Thanks to Jeppe Pihl.
3252
* PR#299: add various options to sphinx-quickstart. Quiet mode option
3253
--quiet will skips wizard mode. Thanks to WAKAYAMA shirou.
3254
* #1623: Return types specified with :rtype: are now turned into links
3255
if possible.
3256
+ Bugs fixed
3257
* see http://sphinx-doc.org/changes.html#release-1-3-released-mar-10-2015
3258
for complete list of fixed bugs
3259
3260
-------------------------------------------------------------------
3261
Tue Sep 9 16:14:01 UTC 2014 - toddrme2178@gmail.com
3262
3263
- Update to 1.2.3:
3264
+ Features added
3265
* #1518: `sphinx-apidoc` command now have a `--version` option to show version
3266
information and exit
3267
* New locales: Hebrew, European Portuguese, Vietnamese.
3268
+ Bugs fixed
3269
* #636: Keep straight single quotes in literal blocks in the LaTeX build.
3270
* #1419: Generated i18n sphinx.js files are missing message catalog entries
3271
from '.js_t' and '.html'. The issue was introduced from Sphinx-1.1
3272
* #1363: Fix i18n: missing python domain's cross-references with currentmodule
3273
directive or currentclass directive.
3274
* #1444: autosummary does not create the description from attributes docstring.
3275
* #1457: In python3 environment, make linkcheck cause "Can't convert 'bytes'
3276
object to str implicitly" error when link target url has a hash part.
3277
Thanks to Jorge_C.
3278
* #1467: Exception on Python3 if nonexistent method is specified by automethod
3279
* #1441: autosummary can't handle nested classes correctly.
3280
* #1499: With non-callable `setup` in a conf.py, now sphinx-build emits
3281
user-friendly error message.
3282
* #1502: In autodoc, fix display of parameter defaults containing backslashes.
3283
* #1226: autodoc, autosummary: importing setup.py by automodule will invoke
3284
setup process and execute `sys.exit()`. Now sphinx avoids SystemExit
3285
exception and emits warnings without unexpected termination.
3286
* #1503: py:function directive generate incorrectly signature when specifying
3287
a default parameter with an empty list `[]`. Thanks to Geert Jansen.
3288
* #1508: Non-ASCII filename raise exception on make singlehtml, latex, man,
3289
texinfo and changes.
3290
* #1531: On Python3 environment, docutils.conf with 'source_link=true' in the
3291
general section cause type error.
3292
* PR#270, #1533: Non-ASCII docstring cause UnicodeDecodeError when uses with
3293
inheritance-diagram directive. Thanks to WAKAYAMA shirou.
3294
* PR#281, PR#282, #1509: TODO extension not compatible with websupport. Thanks
3295
to Takeshi Komiya.
3296
* #1477: gettext does not extract nodes.line in a table or list.
3297
* #1544: `make text` generate wrong table when it has empty table cells.
3298
* #1522: Footnotes from table get displayed twice in LaTeX. This problem has
3299
been appeared from Sphinx-1.2.1 by #949.
3300
* #508: Sphinx every time exit with zero when is invoked from setup.py command.
3301
ex. `python setup.py build_sphinx -b doctest` return zero even if doctest
3302
failed.
3303
3304
-------------------------------------------------------------------
3305
Thu Mar 6 12:50:16 UTC 2014 - mcihar@suse.cz
3306
3307
- Update to 1.2.2:
3308
- PR#211: When checking for existence of the html_logo file, check the full
3309
relative path and not the basename.
3310
- PR#212: Fix traceback with autodoc and __init__ methods without docstring.
3311
- PR#213: Fix a missing import in the setup command.
3312
- #1357: Option names documented by option are now again allowed to not start
3313
with a dash or slash, and referencing them will work correctly.
3314
- #1358: Fix handling of image paths outside of the source directory when
3315
using the “wildcard” style reference.
3316
- #1374: Fix for autosummary generating overly-long summaries if first line
3317
doesn’t end with a period.
3318
- #1383: Fix Python 2.5 compatibility of sphinx-apidoc.
3319
- #1391: Actually prevent using “pngmath” and “mathjax” extensions at the
3320
same time in sphinx-quickstart.
3321
- #1386: Fix bug preventing more than one theme being added by the entry
3322
point mechanism.
3323
- #1370: Ignore “toctree” nodes in text writer, instead of raising.
3324
- #1364: Fix ‘make gettext’ fails when the ‘.. todolist::’ directive is
3325
present.
3326
- #1367: Fix a change of PR#96 that break
3327
sphinx.util.docfields.Field.make_field interface/behavior for item argument
3328
usage.
3329
3330
-------------------------------------------------------------------
3331
Mon Feb 10 15:08:45 UTC 2014 - speilicke@suse.com
3332
3333
- Update to version 1.2.1
3334
+ See CHANGES
3335
- Fix update-alternatives usage
3336
- Removed sphinx-setup_command_unicode.patch (upstream)
3337
3338
-------------------------------------------------------------------
3339
Mon Nov 18 09:05:53 UTC 2013 - speilicke@suse.com
3340
3341
- Fix %preun update-alternatives, used wrong master
3342
3343
-------------------------------------------------------------------
3344
Fri Nov 15 12:17:12 UTC 2013 - speilicke@suse.com
3345
3346
- Only ghost /etc/alternatives on 12.3 or newer
3347
3348
-------------------------------------------------------------------
3349
Wed Nov 13 14:54:09 UTC 2013 - speilicke@suse.com
3350
3351
- Add sphinx-setup_command_unicode.patch: Backport of
3352
https://bitbucket.org/birkenfeld/sphinx/pull-request/193/
3353
3354
-------------------------------------------------------------------
3355
Wed Nov 6 08:10:01 UTC 2013 - speilicke@suse.com
3356
3357
- Updateo version 1.2b3:
3358
+ The Sphinx error log files will now include a list of the loaded extensions
3359
for help in debugging.
3360
+ PR#154: Remove "sphinx" prefix from LaTeX class name except 'sphinxmanual'
3361
and 'sphinxhowto'. Now you can use your custom document class without
3362
'sphinx' prefix. Thanks to Erik B.
3363
+ #1265: Fix i18n: crash when translating a section name that is pointed to from
3364
a named target.
3365
+ A wrong condition broke the search feature on first page that is usually
3366
index.rst. This issue was introduced in 1.2b1.
3367
+ #703: When Sphinx can't decode filenames with non-ASCII characters, Sphinx now
3368
catches UnicodeError and will continue if possible instead of raising the
3369
exception.
3370
- Changes from version 1.2b2 and prior:
3371
+ See CHANGES file
3372
- Own /etc/alternatives/sphinx-* by ghosting (update-alternatives)
3373
- Dropped sphinx-docutils-0.10.patch (merged upstream)
3374
3375
-------------------------------------------------------------------
3376
Thu Oct 24 11:14:54 UTC 2013 - speilicke@suse.com
3377
3378
- Require python-setuptools instead of distribute (upstreams merged)
3379
3380
-------------------------------------------------------------------
3381
Thu Jul 18 09:15:10 UTC 2013 - speilicke@suse.com
3382
3383
- Drop runtime req on python-distribute
3384
3385
-------------------------------------------------------------------
3386
Tue Jul 9 14:16:18 UTC 2013 - dmueller@suse.com
3387
3388
- add sphinx-docutils-0.10.patch:
3389
* add support for docutils 0.10
3390
3391
-------------------------------------------------------------------
3392
Thu May 16 10:33:17 UTC 2013 - speilicke@suse.com
3393
3394
- Fix update-alternatives and support upgrade from previous versions
3395
3396
-------------------------------------------------------------------
3397
Tue Apr 30 14:38:24 UTC 2013 - speilicke@suse.com
3398
3399
- Apply update-alternatives for binaries and man-pages
3400
3401
-------------------------------------------------------------------
3402
Tue Nov 20 11:42:44 UTC 2012 - saschpe@suse.de
3403
3404
- Run testsuite
3405
- Build and install man-pages
3406
3407
-------------------------------------------------------------------
3408
Thu Nov 15 05:29:16 UTC 2012 - saschpe@suse.de
3409
3410
- Revert last "locale" change, it was a false positive
3411
3412
-------------------------------------------------------------------
3413
Tue Nov 6 00:24:32 UTC 2012 - saschpe@suse.de
3414
3415
- Remove obsolete SUSE version checks
3416
- Don't package locale files twice
3417
3418
-------------------------------------------------------------------
3419
Wed May 23 16:02:17 UTC 2012 - highwaystar.ru@gmail.com
3420
3421
- python3 package added
3422
3423
-------------------------------------------------------------------
3424
Wed May 23 12:59:54 UTC 2012 - saschpe@suse.de
3425
3426
- Update to version 1.1.13:
3427
* PR#40: Fix safe_repr function to decode bytestrings with non-ASCII
3428
characters correctly.
3429
* PR#37: Allow configuring sphinx-apidoc via SPHINX_APIDOC_OPTIONS.
3430
* PR#34: Restore Python 2.4 compatibility.
3431
* PR#36: Make the "bibliography to TOC" fix in LaTeX output specific to
3432
the document class.
3433
* #695: When the highlight language "python" is specified explicitly,
3434
do not try to parse the code to recognize non-Python snippets.
3435
* #859: Fix exception under certain circumstances when not finding
3436
appropriate objects to link to.
3437
* #860: Do not crash when encountering invalid doctest examples, just
3438
emit a warning.
3439
* #864: Fix crash with some settings of :confval:modindex_common_prefix.
3440
* #862: Fix handling of -D and -A options on Python 3.
3441
* #851: Recognize and warn about circular toctrees, instead of running
3442
into recursion errors.
3443
* #853: Restore compatibility with docutils trunk.
3444
* #852: Fix HtmlHelp index entry links again.
3445
* #854: Fix inheritance_diagram raising attribute errors on builtins.
3446
* #832: Fix crashes when putting comments or lone terms in a glossary.
3447
* #834, #818: Fix HTML help language/encoding mapping for all Sphinx
3448
supported languages.
3449
* #844: Fix crashes when dealing with Unicode output in doctest extension.
3450
* #831: Provide --project flag in setup_command as advertised.
3451
* #875: Fix reading config files under Python 3.
3452
* #876: Fix quickstart test under Python 3.
3453
* #870: Fix spurious KeyErrors when removing documents.
3454
* #892: Fix single-HTML builder misbehaving with the master document in a
3455
subdirectory.
3456
* #873: Fix assertion errors with empty only directives.
3457
* #816: Fix encoding issues in the Qt help builder.
3458
3459
-------------------------------------------------------------------
3460
Thu Nov 10 11:05:21 UTC 2011 - saschpe@suse.de
3461
3462
- Update to version 1.1.2:
3463
* #809: Include custom fixers in the source distribution.
3464
- Changes from version 1.1.1:
3465
* #791: Fix QtHelp, DevHelp and HtmlHelp index entry links.
3466
* #792: Include "sphinx-apidoc" in the source distribution.
3467
* #797: Don't crash on a misformatted glossary.
3468
* #801: Make intersphinx work properly without SSL support.
3469
* #805: Make the Sphinx.add_index_to_domain method work correctly.
3470
* #780: Fix Python 2.5 compatibility.
3471
3472
-------------------------------------------------------------------
3473
Thu Sep 22 10:58:02 UTC 2011 - saschpe@suse.de
3474
3475
- Require python-docutils instead of docutils
3476
- Change license to BSD-2-Clause (SPDX style, according to LICENSE)
3477
3478
-------------------------------------------------------------------
3479
Wed Aug 31 13:59:59 UTC 2011 - saschpe@suse.de
3480
3481
- Corrected buildrequires/requires:
3482
* python-jinja2 is now python-Jinja2
3483
* python-pygments is now python-Pygments
3484
3485
-------------------------------------------------------------------
3486
Tue Jul 12 09:59:25 UTC 2011 - mcihar@suse.cz
3487
3488
- add python-distribute to Requires, it is needed to run sphinx-build
3489
3490
-------------------------------------------------------------------
3491
Sun Jul 3 11:31:27 UTC 2011 - saschpe@gmx.de
3492
3493
- Renamed to 'python-Sphinx', obsoletes 'python-sphinx'
3494
- Update to version 1.0.7:
3495
* #347: Fix wrong generation of directives of static methods in
3496
autosummary.
3497
* #599: Import PIL as from PIL import Image.
3498
* #558: Fix longtables with captions in LaTeX output.
3499
* Make token references work as hyperlinks again in LaTeX output.
3500
* #572: Show warnings by default when reference labels cannot be
3501
found.
3502
* #536: Include line number when complaining about missing reference
3503
targets in nitpicky mode.
3504
* #590: Fix inline display of graphviz diagrams in LaTeX output.
3505
* #589: Build using app.build() in setup command.
3506
* Fix a bug in the inheritance diagram exception that caused base
3507
classes to be skipped if one of them is a builtin.
3508
* Fix general index links for C++ domain objects.
3509
* #332: Make admonition boundaries in LaTeX output visible.
3510
* #573: Fix KeyErrors occurring on rebuild after removing a file.
3511
* Fix a traceback when removing files with globbed toctrees.
3512
* If an autodoc object cannot be imported, always re-read the
3513
document containing the directive on next build.
3514
* If an autodoc object cannot be imported, show the full traceback
3515
of the import error.
3516
* Fix a bug where the removal of download files and images wasn't
3517
noticed.
3518
* #571: Implement ~ cross-reference prefix for the C domain.
3519
* Fix regression of LaTeX output with the fix of #556.
3520
* #568: Fix lookup of class attribute documentation on descriptors
3521
so that comment documentation now works.
3522
* Fix traceback with only directives preceded by targets.
3523
* Fix tracebacks occurring for duplicate C++ domain objects.
3524
* Fix JavaScript domain links to objects with $ in their name.
3525
- Spec file cleanup:
3526
* Use fdupes and %find_lang
3527
* Removed authors from description
3528
* Make doc package on require %{version}, not %{release}
3529
3530
-------------------------------------------------------------------
3531
Wed Jan 12 09:36:17 UTC 2011 - saschpe@suse.de
3532
3533
- Spec file cleanup
3534
* correct doc package group, no dupes
3535
* added rpmlintrc file
3536
- Update to 1.0.6
3537
* #581: Fix traceback in Python domain for empty cross-reference
3538
targets.
3539
* #283: Fix literal block display issues on Chrome browsers.
3540
* #383, #148: Support sorting a limited range of accented
3541
characters in the general index and the glossary.
3542
* #570: Try decoding -D and -A command-line arguments with
3543
the locale's preferred encoding.
3544
* #528: Observe locale_dirs when looking for the JS
3545
translations file.
3546
* #574: Add special code for better support of Japanese documents
3547
in the LaTeX builder.
3548
* Regression of #77: If there is only one parameter given with
3549
:param: markup, the bullet list is now suppressed again.
3550
* #556: Fix missing paragraph breaks in LaTeX output in certain
3551
situations.
3552
* #567: Emit the autodoc-process-docstring event even for objects
3553
without a docstring so that it can add content.
3554
* #565: In the LaTeX builder, not only literal blocks require
3555
different table handling, but also quite a few other list-like
3556
block elements.
3557
* #515: Fix tracebacks in the viewcode extension for Python objects
3558
that do not have a valid signature.
3559
* Fix strange reportings of line numbers for warnings generated
3560
from autodoc-included docstrings, due to different behavior
3561
depending on docutils version.
3562
* Several fixes to the C++ domain.
3563
3564
-------------------------------------------------------------------
3565
Mon Jan 3 12:04:29 UTC 2011 - nix@opensuse.org
3566
3567
- Update to 1.0.5
3568
3569
-------------------------------------------------------------------
3570
Wed Sep 8 12:35:13 UTC 2010 - nix@opensuse.org
3571
3572
- Update to 1.0.3
3573
3574
-------------------------------------------------------------------
3575
Mon Apr 26 14:34:11 UTC 2010 - nix@opensuse.org
3576
3577
- Update to 0.6.5
3578
3579
-------------------------------------------------------------------
3580
Tue Aug 11 10:53:47 CEST 2009 - cfarrell@suse.de
3581
3582
- Update to 0.6.2 and split docs into separate package
3583
3584
-------------------------------------------------------------------
3585
Fri Jun 5 21:54:31 CEST 2009 - poeml@suse.de
3586
3587
- initial package (0.6.1)
3588
3589