Sphinx 0.4

Release 0.4.3 (8. Okt 2008)

  • Behebt einen Fehler in autodoc mit direkt angegebenen autodoc-Mitgliedern.

  • Behebt einen Fehler in autodoc, der ein Modul zweimal importierte, einmal als "Modul", einmal als "Modul.".

  • Behebt einen Fehler im HTML-Writer, der doppelte id Attribute für Abschnittsüberschriften mit Docutils 0.5 erzeugte.

  • Ruft super() in überschriebenen Blöcken in Templates korrekt auf.

  • Fügt eine Korrektur für die Verwendung von XeTeX hinzu.

  • Vereinheitlicht die Handhabung von LaTeX-Escaping.

  • Baut alles neu auf, wenn sich der extensions Konfigurationswert ändert.

  • Versucht nicht, ein nicht existierendes statisches Verzeichnis zu entfernen.

  • Behebt ein Einrückungsproblem in Produktionslisten.

  • Behebt die Handhabung von Kodierungen für Literal-Include-Dateien: literalinclude hat jetzt eine encoding Option, die standardmäßig auf UTF-8 gesetzt ist.

  • Behebt die Handhabung von Nicht-ASCII-Zeichen, die in quickstart eingegeben wurden.

  • Behebt einen Absturz bei nicht existierenden Bild-URIs.

Release 0.4.2 (29. Jul 2008)

  • Korrigiert das Rendering der samp Rolle in HTML.

  • Behebt einen Fehler, bei dem LaTeX-Links zu Überschriften zu einer falschen Seite führten.

  • Liest Dokumente mit globbed toctrees neu ein, wenn Quelldateien hinzugefügt oder entfernt werden.

  • Fügt einen fehlenden Parameter zu PickleHTMLBuilder.handle_page() hinzu.

  • Setzt Vererbungsinformationen immer auf eine eigene Zeile.

  • Umschließt Code mit Leerzeichen nicht automatisch in Anführungszeichen; dies geschieht nur für die samp Rolle.

  • autodoc gibt nun eine präzisere Fehlermeldung aus, wenn ein Modul nicht importiert werden kann oder ein Attribut nicht gefunden werden kann.

  • Die JavaScript-Suche verwendet nun den korrekten Dateinamen-Suffix, wenn auf gefundene Elemente verwiesen wird.

  • Die Direktive automodule akzeptiert nun wieder die Optionen inherited-members und show-inheritance.

  • Sie können die Dokumente nun normal neu erstellen, nachdem Sie das Quell- und/oder Doctree-Verzeichnis verschoben haben.

Release 0.4.1 (5. Jul 2008)

  • Fügt der TextBuilder-Klasse Handhabung von Unter-/Oberzeichen hinzu.

  • Beschriftungsnamen in Referenzen sind nun case-insensitiv, da reST-Beschriftungsnamen immer kleingeschrieben werden.

  • Behebt Absturz des Linkcheck-Builders bei fehlerhaften URLs.

  • Fügt Kompatibilität für Admonitionen und Docutils 0.5 hinzu.

  • Entfernt die alberne Beschränkung für "rubric" im LaTeX-Writer: Sie können nun beliebige "rubric"-Direktiven schreiben, und nur solche mit dem Titel "Fußnoten" werden ignoriert.

  • Kopiert das HTML-Logo in das Ausgabeverzeichnis _static.

  • Korrigiert LaTeX-Code für Module mit Unterstrichen in Namen und Plattformen.

  • Behebt einen Absturz bei nicht-lokalen Bild-URIs.

  • Erlaubt die Verwendung von :noindex: in automodule Direktiven, wie dokumentiert.

  • Behebt die delete() Docstring-Prozessorfunktion in autodoc.

  • Behebt Warnmeldung für nicht existierende Bilder.

  • Behebt die JavaScript-Suche im Internet Explorer.

Release 0.4 (23. Jun 2008)

Neue Funktionen hinzugefügt

  • tocdepth kann als dateiweiter Metadateneintrag angegeben werden und gibt die maximale Tiefe eines Inhaltsverzeichnisses dieser Datei an.

  • Der neue Konfigurationswert default_role kann verwendet werden, um die Standardrolle für alle Dokumente auszuwählen.

  • Sphinx interpretiert nun Feldlisten mit Feldern wie :param foo: in Beschreibungseinheiten.

  • Die neue Direktive staticmethod kann verwendet werden, um Methoden als statische Methoden zu kennzeichnen.

  • HTML-Ausgabe

    • Die "vorherigen" und "nächsten" Links haben eine logischere Struktur, sodass durch Folgen der "nächsten" Links der gesamte TOC-Baum durchlaufen werden kann.

    • Das neue Ereignis html-page-context kann verwendet werden, um benutzerdefinierte Werte in den Kontext einzufügen, der beim Rendern einer HTML-Vorlage verwendet wird.

    • Dokumentmetadaten befinden sich nun im Standardvorlagenkontext unter dem Namen metadata.

    • Der neue Konfigurationswert html_favicon kann verwendet werden, um ein Favicon für die HTML-Ausgabe festzulegen. Dank an Sebastian Wiesner.

    • Der neue Konfigurationswert html_use_index kann verwendet werden, um die Indexerstellung in HTML-Dokumenten zu deaktivieren.

    • Der neue Konfigurationswert html_split_index kann verwendet werden, um separate Indexseiten für jeden Buchstaben zu erstellen, die verwendet werden, wenn der vollständige Index zu groß für eine Seite ist.

    • Der neue Konfigurationswert html_short_title kann verwendet werden, um einen kürzeren Titel für die Dokumentation festzulegen, der dann in der Navigationsleiste verwendet wird.

    • Der neue Konfigurationswert html_show_sphinx kann verwendet werden, um zu steuern, ob ein Link zu Sphinx in der HTML-Fußzeile hinzugefügt wird.

    • Der neue Konfigurationswert html_file_suffix kann verwendet werden, um die HTML-Dateiendung z.B. auf .xhtml zu setzen.

    • Die Verzeichnisse im html_static_path können nun Unterverzeichnisse enthalten.

    • Der Modulindex wird nun nicht mehr eingeklappt, wenn die Anzahl der Untermodule größer ist als die Anzahl der Top-Level-Module.

  • Die Bilddirektive unterstützt nun die Angabe der Erweiterung als .*, was den Builder dazu veranlasst, diejenige auszuwählen, die am besten passt. Dank an Sebastian Wiesner.

  • Der neue Konfigurationswert exclude_trees kann verwendet werden, um ganze Unterbäume von der Suche nach Quelldateien auszuschließen.

  • Standardwerte für Konfigurationswerte können nun Callables sein, was dynamische Standardwerte ermöglicht.

  • Der neue TextBuilder erzeugt reinen Text-Output.

  • Python 3-ähnliche Signaturen, die eine Rückgabeannotation über -> angeben, werden nun unterstützt.

  • Erweiterungen

    • Die Autodoc-Erweiterung bietet nun eine flexiblere Möglichkeit, Docstrings zu manipulieren, bevor sie in die Ausgabe aufgenommen werden, über das neue Ereignis autodoc-process-docstring.

    • Die autodoc-Erweiterung akzeptiert nun Signaturen für Funktionen, Methoden und Klassen, die die über Introspektion aus dem Python-Code erhaltene Signatur überschreiben.

    • Die autodoc-Erweiterung bietet nun eine Option show-inheritance für autoclass, die eine Liste von Basisklassen nach der Signatur einfügt.

    • Die Autodoc-Direktiven unterstützen nun die Optionsflag noindex.

Behobene Fehler

  • Berichtet korrekt die Quellposition für Docstrings, die mit autodoc aufgenommen wurden.

  • Korrigiert die LaTeX-Ausgabe von Beschreibungseinheiten mit mehreren Signaturen.

  • Handhabt die figure-Direktive in der LaTeX-Ausgabe.

  • Handhabt rohe Admonitionen in der LaTeX-Ausgabe.

  • Korrigiert die Bestimmung des Titels in der HTML-Hilfeausgabe.

  • Verarbeitet Projektnamen, die Leerzeichen enthalten.

  • Schreibt keine SSI-ähnlichen Kommentare in die HTML-Ausgabe.

  • Benennt die Klasse "sidebar" in "sphinxsidebar" um, um sich von reST-Sidebars zu unterscheiden.

  • Verwendet ein binäres TOC bei der Generierung von HTML-Hilfen, um Probleme mit Links ohne explizite Anker zu beheben.

  • Behebt das Verhalten von Referenzen auf Funktionen/Methoden mit explizitem Titel.

  • Unterstützt Zitat-, Unterstrich- und Oberstrichknoten im LaTeX-Writer.

  • Stellt die Standarddirektive "class" als "cssclass" bereit; ansonsten wird sie von der Sphinx-definierten Direktive überschattet.

  • Behebt die Handhabung von expliziten Modulnamen, die an autoclass-Direktiven übergeben werden. Sie werden nun mit dem korrekten Modulnamen in den generierten Dokumenten angezeigt.

  • Ermöglicht Autodoc die Verarbeitung von Unicode-Docstrings.

  • Der LaTeX-Writer übersetzt nun Zeilenblöcke mit \raggedright, was besser mit Tabellen harmoniert.

  • Behebt einen Fehler mit Verzeichnissen im statischen Pfad des HTML-Builders.