Sphinx 1.1

Release 1.1.3 (10. März 2012)

  • PR#40: Korrigiert die Funktion safe_repr, um Bytestrings mit Nicht-ASCII-Zeichen korrekt zu dekodieren.

  • PR#37: Ermöglicht die Konfiguration von sphinx-apidoc über SPHINX_APIDOC_OPTIONS.

  • PR#34: Stellt die Kompatibilität mit Python 2.4 wieder her.

  • PR#36: Macht die Korrektur „Bibliography to TOC“ in der LaTeX-Ausgabe spezifisch für die Dokumentenklasse.

  • #695: Wenn die Hervorhebungssprache „python“ explizit angegeben ist, wird nicht versucht, den Code zu parsen, um Nicht-Python-Snippets zu erkennen.

  • #859: Korrigiert eine Ausnahme unter bestimmten Umständen, wenn keine geeigneten Objekte zum Verlinken gefunden werden.

  • #860: Stürzt nicht ab, wenn ungültige Doctest-Beispiele angetroffen werden, sondern gibt nur eine Warnung aus.

  • #864: Korrigiert einen Absturz bei einigen Einstellungen von modindex_common_prefix.

  • #862: Korrigiert die Behandlung von Optionen -D und -A unter Python 3.

  • #851: Erkennt und warnt vor zirkulären Toctree, anstatt in Rekursionsfehler zu laufen.

  • #853: Stellt die Kompatibilität mit Docutils Trunk wieder her.

  • #852: Korrigiert erneut die Links zu den HtmlHelp-Index-Einträgen.

  • #854: Korrigiert das Auslösen von Attributfehlern bei Builtins durch inheritance_diagram.

  • #832: Korrigiert Abstürze beim Einfügen von Kommentaren oder einzelnen Begriffen in ein Glossar.

  • #834, #818: Korrigiert die HTML-Hilfe-Sprach-/Codierungsmäßige Zuordnung für alle von Sphinx unterstützten Sprachen.

  • #844: Korrigiert Abstürze bei der Behandlung von Unicode-Ausgaben in der Doctest-Erweiterung.

  • #831: Stellt das Flag --project in setup_command wie beworben bereit.

  • #875: Korrigiert das Lesen von Konfigurationsdateien unter Python 3.

  • #876: Korrigiert den Quickstart-Test unter Python 3.

  • #870: Korrigiert scheinbare KeyErrors beim Entfernen von Dokumenten.

  • #892: Korrigiert das Fehlverhalten des Single-HTML-Builders, wenn das Master-Dokument in einem Unterverzeichnis liegt.

  • #873: Korrigiert Assertionsfehler bei leeren only-Direktiven.

  • #816: Korrigiert Kodierungsprobleme im Qt-Hilfe-Builder.

Release 1.1.2 (1. Nov. 2011) – 1.1.1 ist sowieso eine alberne Versionsnummer!

  • #809: Schließt benutzerdefinierte Fixer in die Quellcodeverteilung ein.

Release 1.1.1 (1. Nov. 2011)

  • #791: Korrigiert Index-Eintragslinks für QtHelp, DevHelp und HtmlHelp.

  • #792: Schließt „sphinx-apidoc“ in die Quellcodeverteilung ein.

  • #797: Stürzt bei einem falsch formatierten Glossar nicht ab.

  • #801: Sorgt dafür, dass intersphinx auch ohne SSL-Unterstützung ordnungsgemäß funktioniert.

  • #805: Stellt sicher, dass die Methode Sphinx.add_index_to_domain korrekt funktioniert.

  • #780: Korrigiert die Kompatibilität mit Python 2.5.

Release 1.1 (9. Okt. 2011)

Inkompatible Änderungen

  • Die Direktive py:module gibt ihren platform-Optionswert nicht mehr aus. (Es war das einzige, was die Direktive ausgab, und daher recht inkonsistent.)

  • Unterstützung für alte Abhängigkeitsversionen wurde entfernt; Anforderungen sind jetzt

    • Pygments >= 1.2

    • Docutils >= 0.7

    • Jinja2 >= 2.3

Hinzugefügte Funktionen

  • Unterstützung für Python 3.x hinzugefügt.

  • Neue Builder und Subsysteme

    • Ein Texinfo-Builder wurde hinzugefügt.

    • i18n-Unterstützung für Inhalte, ein gettext-Builder und zugehörige Dienstprogramme wurden hinzugefügt.

    • Die Bibliothek und der Builder websupport wurden hinzugefügt.

    • #98: Ein Skript sphinx-apidoc wurde hinzugefügt, das eine Hierarchie von Quelldateien mit Autodoc-Direktiven zur Dokumentation von Modulen und Paketen generiert.

    • #273: Eine API zum Hinzufügen von Volltextsuchunterstützung für andere Sprachen als Englisch wurde hinzugefügt. Unterstützung für Japanisch wurde hinzugefügt.

  • Markup

    • #138: Eine index-Rolle wurde hinzugefügt, um Inline-Index-Einträge zu erstellen.

    • #454: Weitere Funktionen für Index-Markup wurden hinzugefügt: Markierung von See/See Also-Einträgen und Haupt-Einträgen für einen gegebenen Schlüssel.

    • #460: Die Tiefe der Abschnittsnummerierung für HTML wurde mit der Option numbered der toctree-Direktive eingeschränkt.

    • #586: Eine verbesserte glossary-Markup wurde implementiert, die mehrere Begriffe pro Definition erlaubt.

    • #478: Die Direktive py:decorator wurde hinzugefügt, um Decorators zu beschreiben.

    • Die C++-Domäne unterstützt jetzt Array-Definitionen.

    • Die C++-Domäne unterstützt jetzt Doc-Felder (:param x: innerhalb von Direktiven).

    • Abschnittsüberschriften in only-Direktiven werden nun korrekt behandelt.

    • Die Option emphasize-lines wurde zu den Quellcode-Direktiven hinzugefügt.

    • #678: Die C++-Domäne unterstützt jetzt Oberklassen.

  • HTML-Builder

    • Das Theme pyramid wurde hinzugefügt.

    • #559: html_add_permalinks ist jetzt eine Zeichenkette, die den anzuzeigenden Text für Permalinks angibt.

    • #259: HTML-Tabellenzeilen haben jetzt CSS-Klassen für gerade/ungerade Zeilen, um „Zebra-Styling“ zu ermöglichen.

    • #554: Die Theme-Option sidebarwidth wurde zum Basis-Theme hinzugefügt.

  • Andere Builder

    • #516: Ein neuer Wert für die Option latex_show_urls wurde hinzugefügt, um die URLs in Fußnoten anzuzeigen.

    • #209: Die Konfigurationswerte text_newlines und text_sectionchars wurden hinzugefügt.

    • Der Konfigurationswert man_show_urls wurde hinzugefügt.

    • #472: linkcheck-Builder: Links werden parallel geprüft, HTTP-HEAD-Anfragen werden verwendet und das Timeout kann konfiguriert werden. Neue Konfigurationswerte: linkcheck_timeout und linkcheck_workers.

    • #521: Der Konfigurationswert linkcheck_ignore wurde hinzugefügt.

    • #28: Unterstützung für Zeilen-/Spaltenüberschneidungen in Tabellen im LaTeX-Builder.

  • Konfiguration und Erweiterbarkeit

    • #537: nitpick_ignore wurde hinzugefügt.

    • #306: Das Ereignis env-get-outdated wurde hinzugefügt.

    • Application.add_stylesheet() akzeptiert jetzt vollständige URIs.

  • Autodoc

    • #564: autodoc_docstring_signature wurde hinzugefügt. Wenn aktiviert (Standard), ruft Autodoc die Signatur aus der ersten Zeile des Docstrings ab, wenn sie dort gefunden wird.

    • #176: Die Option private-members wurde für Autodoc-Direktiven bereitgestellt.

    • #520: Die Option special-members wurde für Autodoc-Direktiven bereitgestellt.

    • #431: Doc-Kommentare für Attribute können jetzt in derselben Zeile wie die Zuweisung angegeben werden.

    • #437: Autodoc zeigt jetzt die Werte von Klassen-Datenattributen an.

    • Autodoc unterstützt jetzt die Dokumentation der Signaturen von functools.partial-Objekten.

  • Andere Erweiterungen

    • Die Erweiterung sphinx.ext.mathjax wurde hinzugefügt.

    • #443: Ermöglicht das Referenzieren externer Graphviz-Dateien.

    • Die Option inline wurde zu den Graphviz-Direktiven hinzugefügt und der Standard (Block-Stil) in der LaTeX-Ausgabe korrigiert.

    • #590: Die Option caption wurde zu den Graphviz-Direktiven hinzugefügt.

    • #553: testcleanup-Blöcke wurden in der Doctest-Erweiterung hinzugefügt.

    • #594: trim_doctest_flags entfernt jetzt auch <BLANKLINE>-Indikatoren.

    • #367: Automatische Ausschluss versteckter Mitglieder in Vererbungsdiagrammen wurde hinzugefügt, sowie eine Option zur selektiven Aktivierung.

    • pngmath_add_tooltips wurde hinzugefügt.

    • Die Math-Erweiterungs-Direktiven für `displaymath` unterstützen nun zusätzlich zu `label` auch `name` für die Angabe der Gleichungsbezeichnung, zur Kompatibilität mit Docutils.

  • Neue Lokalisierungen

    • #221: Schwedische Lokalisierung wurde hinzugefügt.

    • #526: Iranische Lokalisierung wurde hinzugefügt.

    • #694: Lettische Lokalisierung wurde hinzugefügt.

    • Nepalesische Lokalisierung wurde hinzugefügt.

    • #714: Koreanische Lokalisierung wurde hinzugefügt.

    • #766: Estnische Lokalisierung wurde hinzugefügt.

  • Behobene Fehler

    • #778: Link „Suchtreffer ausblenden“ auf Seiten, auf die über die Suche verlinkt wird, korrigiert.

    • Quellcode-Positionen, auf die von der „viewcode“-Erweiterung verwiesen wird, korrigiert.