Sphinx 1.7¶
Release 1.7.9 (veröffentlicht am 05. Sep. 2018)¶
Hinzugefügte Funktionen¶
#5359: Generierte Texinfo-Dateien reproduzierbar machen durch Sortieren der Anker
Behobene Fehler¶
#5361: Absturz bei inkrementellem Build, wenn ein Dokument die include-Direktive verwendet
Release 1.7.8 (veröffentlicht am 29. Aug. 2018)¶
Inkompatible Änderungen¶
Der Typ von
env.includedwurde zu dict von set geändert
Behobene Fehler¶
#5320: intersphinx: Absturz, wenn eine ungültige URL angegeben wurde
#5326: manpage: Absturz bei Angabe eines ungültigen docname in
man_pages#5322: autodoc:
Anytypehint verursacht Formatierungsfehler#5327: „document isn’t included in any toctree“-Warnung bei Neubau mit generierten Dateien
#5335: quickstart: Escape-Sequenz wird mit MacPorts’ python angezeigt
Release 1.7.7 (veröffentlicht am 19. Aug. 2018)¶
Behobene Fehler¶
#5198: Warnung „document not in toctree“, wenn Dateien nur für parallele Builds eingeschlossen werden
LaTeX: Reduzieren von „Token not allowed in a PDF string“-Warnungen für Hyperref in der LaTeX-Konsolenausgabe (Siehe: #5236)
LaTeX: Unterdrücken von „remreset Warning: The remreset package is obsolete“-Warnungen in der LaTeX-Konsolenausgabe mit aktuellem LaTeX (Siehe: #5237)
#5234: PDF-Ausgabe: Verwendung der PAPER-Umgebungsvariable ist seit Sphinx 1.5 kaputt
LaTeX: Korrektur der Dokumentation für
latex_enginebezüglich der Latin Modern-Schriftart mit XeLaTeX/LuaLateX (Siehe: #5251)#5280: autodoc: Korrektur von falschen Typannotationen für komplexe Typen
autodoc: Optionale Typen werden falsch gerendert
#5291: autodoc stürzt ab bei ForwardRef-Typen
#5211: autodoc: Keine Dokumentation für functools.partial-Funktionen generiert
#5306: autodoc:
getargspec()löst NameError für ungültige Typehints aus#5298: imgmath: math_number_all verursacht, dass Gleichungen zwei Nummern in HTML haben
#5294: sphinx-quickstart leere Prompts in PowerShell
Release 1.7.6 (veröffentlicht am 17. Jul. 2018)¶
Behobene Fehler¶
#5037: LaTeX
\sphinxupquote{}bricht im Russischensphinx.testing verwendet veraltete pytest-API;
Node.get_marker(name)#5016: Absturz bei aktivierter recommonmark.AutoStrictify
#5022: latex: Absturz mit Docutils-Paket von Debian/Ubuntu
#5009: latex: Eine Beschriftung für Tabellen verschwindet, wenn die Tabelle keine Bildunterschrift hat
#5048: Absturz mit nummeriertem toctree
#2410: C, leere Argumentlisten für Makros rendern.
C++, Korrektur der Suche nach vollständigen Vorlagenspezialisierungen ohne Vorlagenargumente.
#4667: C++, Korrektur der Assertion bei fehlenden Referenzen im globalen Geltungsbereich bei Verwendung von intersphinx. Dank an Alan M. Carroll.
#5019: autodoc: Absturz durch Form Feed-Zeichen
#5032: autodoc: Verliert das erste statische Methodenargument für alte Klassen
#5036: quickstart: Eingabe von Strg+U löscht die gesamte Zeile
#5066: html: Seitenleiste „relations“ wird nicht standardmäßig angezeigt
#5091: latex: geschweifte Klammern in Indexeinträgen werden nicht korrekt behandelt
#5070: epub: Falsche interne href-Fragment-Links
#5104: apidoc: Schnittstelle von
sphinx.apidoc:main()hat sich geändert#4272: PDF-Builds französischer Projekte haben Probleme mit XeTeX
#5076: napoleon löst RuntimeError mit python 3.7 aus
#5125: sphinx-build: Schnittstelle von
sphinx:main()hat sich geändertsphinx-build:
sphinx.cmd.build.main()bezieht sich aufsys.argvanstatt auf übergebene Argumente#5146: autosummary: Warnung wird ausgegeben, wenn die erste Zeile des Docstrings mit einer literalen Notation endet
autosummary: Warnungen von autosummary zeigen falschen Speicherort an (Siehe: #5146)
#5143: autodoc: Absturz bei der Inspektion von dict-ähnlichen Objekten, die kein Sortieren unterstützen
#5139: autodoc: Enum-Argument fehlt, wenn es denselben Wert wie ein anderes hat
#4946: py domain: rtype-Feld konnte „
None“ nicht als Typ behandeln#5176: LaTeX: Indexierung von Begriffen, die
@,!oder"enthalten, schlägt fehl#5161: html: Absturz, wenn das Kopieren statischer Dateien fehlschlägt
#5167: autodoc: Korrektur der Formatierung von Typannotationen für Tupel mit mehr als zwei Argumenten
#3329: i18n: Absturz durch automatische Symbol-Fußnotenreferenzen
#5158: autosummary: Modulübersicht ist kaputt, wenn sie mit einer Überschrift beginnt
Release 1.7.5 (veröffentlicht am 29. Mai 2018)¶
Behobene Fehler¶
#4924: html search: Großbuchstabenproblem in anderen Sprachen
#4932: apidoc: Einige Unterpakete werden ignoriert, wenn ein Geschwister-Unterpaket ein Modul mit Unterstrich enthält
#4863, #4938, #4939: i18n behandelt node.title nicht korrekt, wie es für Inhaltsverzeichnisse, Themen, Tadel, Tabellen und Abschnitte verwendet wird.
#4913: i18n: Literale Blöcke in Aufzählungslisten werden nicht übersetzt
#4962: C++, löste TypeError bei doppelter Deklaration aus.
#4825: C++, korrekte Analyse von expr-Rollen und bessere Fehlermeldungen bei (escaped) Zeilenumbrüchen.
C++, korrekte Verwendung von
desc_addname-Knoten für Präfixe von Namen.C++, Analyse von Paket-Erweiterungen in Funktionsaufrufen.
#4915, #4916: Links auf der Suchseite sind kaputt, wenn der dirhtml-Builder verwendet wird
#4969: autodoc: Konstruktormethode sollte keine Rückgabe-Annotation haben
latex: Tief verschachtelte nummerierte Listen, die mit einer Nicht-1 beginnen, verursachen einen Absturz der LaTeX-Engine
#4978: latex: shorthandoff wird nicht für das Brasilien-Locale eingerichtet
#4928: i18n: Ignorieren von Punktverzeichnissen wie .git/ in LC_MESSAGES/
#4946: py domain: Typfeld konnte „
None“ nicht als Typ behandeln#4979: latex: Falsches Escaping von geschweiften Klammern in Indexeinträgen
#4956: autodoc: Fehler beim Extrahieren der Dokumentation aus einer Unterklasse der Klasse in einem gemockten Modul
#4973: latex: Glossardirektive fügt jedem Element einen Leerraum hinzu
#4980: latex: Explizite Beschriftungen für Codeblöcke sind doppelt
#4919: node.asdom() stürzt ab, wenn toctree die Option :numbered: hat
#4914: autodoc: Parsing-Fehler bei der Verwendung von Dataclasses ohne Standardwerte
#4931: autodoc: Absturz, wenn Handler für autodoc-skip-member einen Fehler auslöst
#4931: autodoc: Absturz, wenn Unterklassen von gemockten Klassen vom Napoleon-Modul verarbeitet werden
#5007: sphinx-build stürzt ab, wenn das Fehlerprotokoll ein „%“-Zeichen enthält
Release 1.7.4 (veröffentlicht am 25. Apr. 2018)¶
Behobene Fehler¶
#4885, #4887: domains: Absturz bei doppelten Objekten
#4889: latex: sphinx.writers.latex verursacht rekursiven Import
Release 1.7.3 (veröffentlicht am 23. Apr. 2018)¶
Behobene Fehler¶
#4769: autodoc verliert das erste statische Methodenargument
#4790: autosummary: zu breite zweispaltige Tabellen in PDF-Builds
#4795: LaTeX-Anpassung über
_templates/longtable.tex_tist kaputt#4789: imgconverter: verwirrt durch convert.exe von Windows
#4783: Unter Windows stürzte Sphinx ab, wenn sich die Laufwerke von srcdir und outdir unterschieden
#4812: autodoc ignoriert typannotierte Variablen
#4817: falsche URLs in Warnmeldungen
#4784: latex:
latex_show_urlsweist falsche Fußnotennummern zu, wenn Hyperlinks innerhalb von Substitutionen vorhanden sind#4837: latex mit der Klasse memoir Fehler: Font-Befehl
\sfwird nicht unterstützt#4803: latex: zu langsam im Verhältnis zur Anzahl automatisch nummerierter Fußnoten
#4838: htmlhelp: Die Einträge in der .hhp-Datei sind nicht sortiert
toctree-Direktive versucht, nach URLs mit Query-Strings zu suchen
#4871: html search: Großbuchstabenproblem im Deutschen
#4717: latex: Kompilierung deutscher Dokumente schlug mit LuaLaTeX und XeLaTeX fehl
#4459: Duplizierte Labels-Erkennung funktioniert im parallelen Build nicht gut
#4878: Absturz mit Erweiterung, die ungültige Metadaten zurückgibt
Release 1.7.2 (veröffentlicht am 21. Mär. 2018)¶
Inkompatible Änderungen¶
#4520: apidoc: Ordner mit einem leeren __init__.py werden nicht mehr vom TOC ausgeschlossen
Behobene Fehler¶
#4669: sphinx.build_main und sphinx.make_main werfen NameError
#4685: autosummary gibt bedeutungslose Warnungen aus
autodoc: Absturz bei ungültigen Optionen
pydomain: immer Klammern entfernen, wenn leer (Siehe: #1042)
#4689: autosummary: schneidet Docstrings, die „i.e.“ enthalten, unerwartet ab
#4701: viewcode: Falsch platzierte
<div>in der viewcode HTML-Ausgabe#4444: Keine Aufforderung, numfig zu verwenden, um :numref: auf Abschnitte anzuwenden
#4727: Optionskonflikt für das Paket textcomp
#4725: Sphinx funktioniert nicht mit python 3.5.0 und 3.5.1
#4716: Generierung einer PDF-Datei mit TexLive unter Windows, Fehler „Datei nicht gefunden“
#4574: Vertikaler Abstand vor Gleichung in LaTeX
#4720: Meldung, wenn ein Bild für den Builder nicht übereinstimmt, ist unklar
#4655, #4684: Unvollständige Lokalisierungsstrings in Polnisch und Chinesisch
#2286: Sphinx stürzt ab, wenn ein Fehler beim Rendern von HTML-Seiten auftritt
#4688: Fehler beim Herunterladen von Remote-Bildern mit langer URL
#4754: sphinx/pycode/__init__.py löst AttributeError aus
#1435: qthelp-Builder sollte Schlüsselwörter htmlescapen
epub: Korrektur der docTitle-Elemente von toc.ncx werden nicht escaped
#4520: apidoc: Unterpaket nicht im TOC (eingeführt in 1.6.6) jetzt behoben
#4767: html: Suche-Hervorhebung bricht MathJax-Gleichungen
Release 1.7.1 (veröffentlicht am 23. Feb. 2018)¶
Veraltet¶
#4623:
sphinx.build_main()ist veraltet.autosummary: Die Schnittstelle von
sphinx.ext.autosummary.get_documenter()hat sich geändert (seit 1.7.0)#4664:
sphinx.ext.intersphinx.debug()ist veraltet.
Weitere Details finden Sie unter Liste veralteter APIs.
Behobene Fehler¶
#4608: epub: Ungültiges Meta-Tag wird generiert
#4260: autodoc: Schlüsselwort-Argument-Trennzeichen verschwindet nicht, wenn es am Anfang der Argumentliste steht
#4622: epub:
epub_schemewirkt sich nicht auf content.opf aus#4627: graphviz: Graphviz-Bilder an Seite anpassen
#4617: quickstart: PROJECT_DIR-Argument ist erforderlich
#4623: sphinx.build_main existiert nicht mehr in 1.7.0
#4615: Das Argument von
sphinx.buildhat sich in 1.7.0 geändertautosummary: Die Schnittstelle von
sphinx.ext.autosummary.get_documenter()hat sich geändert#4630: Determinieren der Reihenfolge von msgids in sphinx.pot
#4563: autosummary: Erkennung von Zeilenendungszeichen ist falsch
#4577: Nummerierte Unterlisten mit explizitem Start mit falscher Nummer
#4641: Ein externer Link im TOC kann „?“ mit der Option
:glob:nicht enthaltenC++, Hinzufügen der fehlenden Analyse von expliziten Casts und typeid in der Ausdrucksanalyse.
C++, Hinzufügen der fehlenden Analyse von
thisin der Ausdrucksanalyse.#4655: Korrektur unvollständiger Lokalisierungsstrings in Polnisch
#4653: Fehlerberichterstattung für parameterlose ImportErrors korrigiert
#4664: Lesen von objects.inv schlägt erneut fehl
#4662:
any-Referenzen mitterm-Zielen stürzen ab, wenn eine Mehrdeutigkeit auftritt
Release 1.7.0 (veröffentlicht am 12. Feb. 2018)¶
Abhängigkeiten¶
1.7.0b1
Hinzufügen des
packaging-Pakets
Inkompatible Änderungen¶
1.7.0b1
#3668: Die Argumente der Hauptfunktionen für jeden Befehl wurden geändert
#3893: Unbekannte html_theme_options erzeugen Warnungen anstelle von Fehlern
#3927: Python-Parameter-/Variablentypen sollten mit Klassen übereinstimmen, nicht mit allen Objekten
#3962: sphinx-apidoc erkennt ein gegebenes Verzeichnis als implizites Namespace-Paket, wenn die Option
--implicit-namespacesgegeben ist, nicht Unterverzeichnisse des gegebenen Verzeichnisses.#3929: apidoc: Verschieben von sphinx.apidoc nach sphinx.ext.apidoc
#4226: apidoc: Generieren des neuen Make-Datei-Stils (make-mode)
#4274: sphinx-build gibt 2 als Exit-Code bei Argumentfehlern zurück
#4389: Ausgabeverzeichnis wird nach dem Laden von Erweiterungen erstellt
autodoc erzeugt keine Warnmeldungen im generierten Dokument, auch wenn
keep_warningsaufTruegesetzt ist. Sie werden nur an stderr ausgegeben.Shebang-Zeile wurde aus der generierten conf.py entfernt
#2557: autodoc:
autodoc_mock_importsmockt nur die angegebenen Module mit ihren Nachkommen. Es mockt nicht ihre Vorfahren. Wenn Sie diese mocken möchten, geben Sie explizit den Namen der Vorfahren an.#3620: html theme: DOCUMENTATION_OPTIONS in eine unabhängige JavaScript-Datei verschoben (Siehe: #4295)
#4246: Begrenzen der Breite des Textkörpers für alle Themen. Konfigurierbar über die Themenoptionen
body_min_widthundbody_max_width.#4771: apidoc: Die Argumente
exclude_patternswerden ignoriert, wenn sie direkt nach den Kommandozeilenoptionen platziert werden
1.7.0b2
#4467: html theme: Umbenennen des
csss-Blocks incss
Veraltet¶
1.7.0b1
Die Verwendung einer Zeichenkette für
html_sidebarsist veraltet und nur Listenwerte werden in 2.0 akzeptiert.format_annotation()undformatargspec()sind veraltet. Bitte verwenden Sie stattdessensphinx.util.inspect.Signature.sphinx.ext.autodoc.AutodocReporterwird durchsphinx.util.docutils. switch_source_input()ersetzt und ist nun veraltet. Es wird in Sphinx 2.0 entfernt.sphinx.ext.autodoc.add_documenter()undAutoDirective._registersind nun veraltet. Bitte verwenden Sie stattdessenapp.add_autodocumenter().AutoDirective._special_attrgettersist nun veraltet. Bitte verwenden Sie stattdessenapp.add_autodoc_attrgetter().
Hinzugefügte Funktionen¶
1.7.0b1
C++, Behandlung von
decltype(auto).#2406: C++, Hinzufügen der korrekten Analyse von Ausdrücken, einschließlich der Verknüpfung von Bezeichnern.
C++, Hinzufügen einer
cpp:expr-Rolle zum Einfügen von Inline-C++-Ausdrücken oder -Typen.C++, Unterstützung expliziter Mitgliedsinstanziierungen mit Kurzform-Präfix
templateC++, Funktionenparameter verknüpfbar machen, wie Vorlagenparameter.
#3638: Möglichkeit, die Beschriftung einer Referenz auf eine Gleichung mit
math_eqref_formatzu ändernJetzt akzeptiert
suppress_warningsdie folgenden Konfigurationenref.python(Siehe: #3866)
#3872: Hinzufügen eines LaTeX-Schlüssels zur Konfiguration der Position von literalen Blöcken in der PDF-Ausgabe (Siehe: #3792, #1723)
Bei fehlender Docstring versuchen Sie, die Doku aus Basisklassen abzurufen (Siehe: #3140)
#4023: Klärung der Fehlermeldung, wenn eine Rolle mehr als ein Ziel hat.
#3973: epub: Überschreiben des Erstellungsdatums zulassen
#3972: epub: Manifest-Einträge nach Dateiname sortieren
#4052: viewcode: Vor dem Hervorheben des Modulcodes sortieren
#1448: qthelp: Neue Konfigurationswerte hinzufügen;
qthelp_namespace#4140: html themes: Body-Tag erblich machen
#4168: Verbesserung der chinesischen Suche mit jieba
HTML-Themes können Standard-Seitenleisten über
theme.confeinrichten#3160: html: Verwenden Sie
<kdb>, um die Rolle:kbd:darzustellen#4212: autosummary: Alle Ausnahmen beim Importieren von Modulen abfangen
#4166: Hinzufügen von
math_numfigfür Gleichungsnummerierung nach Abschnitt (Siehe: #3991, #4080). Dank an Oliver Jahn.#4311: Lassen Sie LaTeX
numfig_secnum_depthfür Abbildungen, Tabellen und Codeblöcke befolgen#947: autodoc unterstützt jetzt ignore-module-all, um
__all__eines Moduls zu ignorieren#4332: Lassen Sie LaTeX
math_numfigfür die Gleichungsnummerierung befolgen#4093: sphinx-build erstellt leere Verzeichnisse für unbekannte Ziele/Builder
Hinzufügen der Option
top-classesfür die Erweiterungsphinx.ext.inheritance_diagram, um den Geltungsbereich von Vererbungsgraphen zu begrenzen.#4183: doctest: Die Option
:pyversion:folgt auch der PEP-440-Spezifikation#4235: html: Hinzufügen von
manpages_url, um Manpage-Rollen zu Hyperlinks zu machen#3570: autodoc: Modul „typing.“ nicht für Typ-Hints anzeigen
#4354: sphinx-build gibt jetzt eine Abschlussmeldung aus. Builder können diese über das Attribut
Builder.epilogändern#4245: html themes: Hinzufügen von
languagezur Liste der JavaScript-Variablen#4079: html: Hinzufügen der Klasse
notranslatezu jedem Code-Block, Literal und jeder Mathematik, damit Google Translate weiß, dass sie nicht übersetzbar sind#4137: doctest: Doctest-Block wird immer als Python-Konsole (pycon) hervorgehoben
#4137: doctest: Testcode-Block wird immer als Python hervorgehoben
#3998: text: Abschnitte standardmäßig nummerieren. Sie können dies mit
text_add_secnumbersundtext_secnumber_suffixsteuern
1.7.0b2
#4271: sphinx-build unterstützt eine Option namens
-j auto, um die Anzahl der Prozesse automatisch anzupassen.Napoleon: Option zum Angeben benutzerdefinierter Abschnitts-Tags hinzugefügt.
Entfernte Funktionen¶
1.7.0b1
Konfigurationsvariablen
html_use_smartypantslatex_keep_old_macro_nameslatex_elements[‘footer’]
Hilfsmethoden der Klasse
sphinx.application.Sphinxbuildername (Eigenschaft)
_display_chunk()
old_status_iterator()
status_iterator()
_directive_helper()
Hilfsmethoden der Klasse
sphinx.environment.BuildEnvironmentcurrmodule (Eigenschaft)
currclass (Eigenschaft)
epub2 Builder
prefix und colorfunc Parameter für warn()
Modul
sphinx.util.compatsphinx.util.nodes.process_only_nodes()LaTeX-Umgebung
notice, verwenden Sie stattdessensphinxadmonitionLaTeX
\sphinxstylethead, verwenden Sie\sphinxstyletheadfamilyC++, Unterstützung von Funktionskonzepten. Dank an mickk-on-cpp.
Nicht verwendete und bisher nicht dokumentierte LaTeX-Makros
\shortversionund\setshortversion
Behobene Fehler¶
1.7.0b1
#3882: Aktualisieren der Reihenfolge der Dateien für HTMLHelp und QTHelp
#3962: sphinx-apidoc erkennt implizite Namespace-Pakete nicht korrekt
#4094: C++, erlauben leere Vorlagenargumentlisten.
C++, auch Typen im Namen von Deklarationen mit qualifizierten Namen verknüpfen.
C++, keine Indexeinträge für Deklarationen innerhalb von Konzepten hinzufügen.
C++, Unterstützung des Vorlagen-Disambiguators für abhängige Namen.
#4314: Für PDF-‚howto‘-Dokumente unterscheidet sich die Nummerierung von Codeblöcken von der von Abbildungen und Tabellen
#4330: PDF-‚howto‘-Dokumente haben eine inkonsistente Standardeinstellung für den LaTeX-tocdepth-Zähler
#4198: autosummary löst mehrere ‚autodoc-process-docstring‘-Ereignisse aus. Dank an Joel Nothman.
#4081: Warnungen und Fehler werden beim Bauen gleichfarbig dargestellt
latex: ‚Release‘-Label nicht anzeigen, wenn
releasenicht gesetzt ist
1.7.0b2
#4415: autodoc klassifiziert geerbte Classmethods als normale Methoden
#4415: autodoc klassifiziert geerbte Staticmethods als normale Methoden
#4472: DOCUMENTATION_OPTIONS ist nicht definiert
#4491: autodoc: _MockImporter gegenüber anderen Importern in sys.meta_path bevorzugen
#4490: autodoc: Typannotation ist mit python 3.7.0a4+ kaputt
Das utils-Paket wird nicht mehr installiert
#3952: apidoc: Modulüberschrift ist zu stark escaped
#4275: Formate, die von sphinx.util.i18n.format_date akzeptiert werden, sind begrenzt
#4493: recommonmark löst AttributeError aus, wenn AutoStructify aktiviert ist
#4209: intersphinx: Im Link-Titel sollte „v“ optional sein, wenn das Ziel keine Version hat
#4230: Verlangsamung beim Schreiben von Seiten mit Sphinx 1.6
#4522: epub: Dokument wird nicht neu erstellt, auch wenn die Konfiguration geändert wurde
1.7.0b3
#4019: inheritance_diagram AttributeError stoppt den Make-Prozess
#4531: autosummary: Methoden werden nicht als Attribute behandelt
#4538: autodoc:
sphinx.ext.autodoc.Optionswurde verschoben#4539: autodoc gibt Warnungen für partialmethods aus
#4223: doctest: Fehlerhafte Tests werden in der falschen Datei, an der falschen Zeile gemeldet
i18n: Nachrichten-Kataloge werden nicht kompiliert, wenn spezifische Dateinamen für
sphinx-buildals Argumente angegeben werden (Siehe: #4560)#4027: sphinx.ext.autosectionlabel erwartet nun, dass Labels mit denen im Quelltext übereinstimmen; keine intelligenten Anführungszeichen, nichts Besonderes.
#4581: apidoc: Ausgeschlossene Module werden immer noch einbezogen
Tests¶
1.7.0b1
Unterstützung für Docutils 0.14 hinzugefügt
Tests für die Erweiterung
sphinx.ext.inheritance_diagramhinzugefügt.