Sphinx 2.1¶

Release 2.1.2 (veröffentlicht 19. Juni 2019)¶

Behobene Fehler¶

#6497: Benutzerdefinierte Lexer schlagen beim Syntaxfehler beim Hervorheben fehl
#6478, #6488: Info-Feldlisten werden falsch erkannt

Release 2.1.1 (veröffentlicht 10. Juni 2019)¶

Inkompatible Änderungen¶

#6447: autodoc: Beenden der Generierung von Dokumenten für undokumentierte Modulvariablen

Behobene Fehler¶

#6442: LaTeX: Anmerkungen vom Typ note können durch Seitenumbruch vom unmittelbar vorausgehenden Abschnittstitel getrennt werden
#6448: autodoc: Absturz beim Dokumentieren von Klassen mit __slots__ = None
#6451: autodoc: Generiert Dokumente für „optional importierte“ Module als Variablen
#6452: autosummary: Absturz bei der Generierung von Dokumenten für Eigenschaften
#6455: napoleon: Docstrings für Eigenschaften werden nicht verarbeitet
#6436: napoleon: Fehler „Unbekannter Zielname“, wenn Variablenname mit Unterstrich endet
#6440: apidoc: Fehlende Leerzeilen zwischen Modulen

Release 2.1.0 (veröffentlicht 02. Juni 2019)¶

Inkompatible Änderungen¶

Ignoriere Dateinamen ohne Dateierweiterung, die direkt an die Builder.build_specific() API übergeben werden
#6230: Der Anker des Begriffs in der Glossardirektive wird geändert, wenn er aus Nicht-ASCII-Zeichen besteht
#4550: html: Tabellen standardmäßig mit CSS zentrieren
#6239: latex: xelatex und xeCJK werden standardmäßig für chinesische Dokumente verwendet
Sphinx.add_lexer() nimmt jetzt eine Lexer-Klasse anstelle einer Instanz entgegen. Eine Instanz von Lexern wird bis Sphinx 3.x unterstützt.

Veraltet¶

sphinx.builders.latex.LaTeXBuilder.apply_transforms()
sphinx.builders._epub_base.EpubBuilder.esc()
sphinx.directives.Acks
sphinx.directives.Author
sphinx.directives.Centered
sphinx.directives.Class
sphinx.directives.CodeBlock
sphinx.directives.Figure
sphinx.directives.HList
sphinx.directives.Highlight
sphinx.directives.Include
sphinx.directives.Index
sphinx.directives.LiteralInclude
sphinx.directives.Meta
sphinx.directives.Only
sphinx.directives.SeeAlso
sphinx.directives.TabularColumns
sphinx.directives.TocTree
sphinx.directives.VersionChange
sphinx.domains.python.PyClassmember
sphinx.domains.python.PyModulelevel
sphinx.domains.std.StandardDomain._resolve_citation_xref()
sphinx.domains.std.StandardDomain.note_citations()
sphinx.domains.std.StandardDomain.note_citation_refs()
sphinx.domains.std.StandardDomain.note_labels()
sphinx.environment.NoUri
sphinx.ext.apidoc.format_directive()
sphinx.ext.apidoc.format_heading()
sphinx.ext.apidoc.makename()
sphinx.ext.autodoc.importer.MockFinder
sphinx.ext.autodoc.importer.MockLoader
sphinx.ext.autodoc.importer.mock()
sphinx.ext.autosummary.autolink_role()
sphinx.ext.imgmath.DOC_BODY
sphinx.ext.imgmath.DOC_BODY_PREVIEW
sphinx.ext.imgmath.DOC_HEAD
sphinx.transforms.CitationReferences
sphinx.transforms.SmartQuotesSkipper
sphinx.util.docfields.DocFieldTransformer.preprocess_fieldtypes()
sphinx.util.node.find_source_node()
sphinx.util.i18n.find_catalog()
sphinx.util.i18n.find_catalog_files()
sphinx.util.i18n.find_catalog_source_files()

Weitere Details finden Sie unter Liste veralteter APIs.

Hinzugefügte Funktionen¶

Hilfsklasse sphinx.transforms.post_transforms.SphinxPostTransform hinzugefügt
Hilfsmethoden hinzugefügt
- PythonDomain.note_module()
- PythonDomain.note_object()
- SphinxDirective.set_source_info()
#6180: Unterstützung für --keep-going mit der Setup-Befehlszeile BuildDoc
math-Direktive unterstützt jetzt die Option :class:
todo: Die todo-Direktive unterstützt jetzt die Option :name:
Überschreibung über die Umgebung von SPHINXOPTS und SPHINXBUILD Makefile-Variablen aktiviert (siehe #6232, #6303)
#6287: autodoc: Gebundene Instanzmethoden, die als Modulfunktionen exportiert werden, können nicht dokumentiert werden
#6289: autodoc: autodoc_default_options unterstützt jetzt die Option imported-members
#4777: autodoc: Unterstützung für Coroutinen
#744: autodoc: Unterstützung für abstractmethod
#6325: autodoc: Unterstützung für Attribute in __slots__. Bei dict-artigen __slots__ betrachtet autodoc die Werte als Docstring des Attributs
#6361: autodoc: autodoc_typehints hinzugefügt, um Type-Hints aus der Signatur zu unterdrücken
#1063: autodoc: Die Direktive automodule behandelt jetzt undokumentierte Variablen auf Modulebene
#6212: autosummary: autosummary_imported_members hinzugefügt, um importierte Member in autosummary anzuzeigen
#6271: make clean ist katastrophal fehlerhaft, wenn in „.“ gebaut wird
#6363: Unterstützung für die Umgebungsvariable %O% in make.bat
#4777: py-Domäne: Option :async: zur Direktive py:function hinzugefügt
py-Domäne: Neue Optionen zur Direktive py:method hinzugefügt
- :abstractmethod
- :async
- :classmethod
- :property
- :staticmethod
rst-Domäne: Direktive rst:directive:option hinzugefügt, um die Option für eine Direktive zu beschreiben
#6306: html: Suchfeld ein Label für Barrierefreiheit hinzugefügt
#4390: html: Konsistentes und semantisches CSS für Signaturen
#6358: Die Eigenschaft rawsource von production-Knoten enthält jetzt die vollständige Produktionsregel
#6373: autosectionlabel: Unterdrückung von Warnungen ermöglicht
coverage: Unterstützung einer neuen Option coverage_ignore_pyobjects
#6239: latex: Unterstützung zum Erstellen chinesischer Dokumente

Behobene Fehler¶

#6230: Ein unangemessener node_id wurde von der Glossardirektive generiert, wenn der Begriff aus Nicht-ASCII-Zeichen bestand
#6213: ifconfig: Inhalte nach Überschriften werden nicht angezeigt
Auskommentierter Begriff in der Glossardirektive wird falsch erkannt
#6299: rst-Domäne: rst:directive-Direktive erzeugt unnötigen Platz
#6379: py-Domäne: Modulindex (py-modindex.html) hat doppelte Titel
#6331: man: Ungültige Ausgabe, wenn doctest auf ein Rubrum folgt
#6351: Meldung „Hyperlink-Ziel wird nicht referenziert“ wird angezeigt, obwohl es referenziert wird
#6165: autodoc: tab_width-Einstellung von Docutils wurde ignoriert
#6347: autodoc: Absturz mit einem einfachen Tuple unter Python 3.6 und 3.5
#6311: autosummary: Autosummary-Tabelle wird durch komplexe Type-Hints verwirrt
#6350: autosummary: Verwirrt durch ein Argument mit einer Art von Standardwert
Generierten Makefiles fehlt ein abschließendes EOL (siehe #6232)
#6375: extlinks: Winkelklammern in der Link-Beschriftung können nicht escaped werden
#6378: linkcheck: Senden eines häufig verwendeten User-Agent
#6387: html-Suche: Dokument konnte mit den Themes haiku und scrolls nicht durchsucht werden
#6408: html-Suche: Behebung der Rangfolge von Suchergebnissen
#6406: Falsches Jahr wird für SOURCE_DATE_EPOCH zurückgegeben
#6402: Direktive image stürzt bei unbekanntem Bildformat ab
#6286: C++, Zulassen von 8 und 9 in hexadezimalen Ganzzahl-Literalen.
#6305: Korrigieren des Strings in quickstart für das Argument ‚path‘ des Parsers
LaTeX: Bilder in Anmerkungen erzeugten Fehler (siehe #6364)