Sphinx 0.6

Release 0.6.7 (05. Juni 2010)

  • #440: Entfernt die Nutzung einer Python >= 2.5 API in der literalinclude Direktive.

  • Behob einen Fehler, der das Generieren einiger Referenzen im LaTeX-Builder verhinderte.

  • #428: Fügt einige fehlende CSS-Stile für Standard-Docutils-Klassen hinzu.

  • #432: Behebt UnicodeErrors beim Erstellen von LaTeX in übersetzten Lokalen.

Release 0.6.6 (25. Mai 2010)

  • Behandelt Rohknoten im text Writer.

  • Behebt ein Problem mit dem Qt-Hilfeprojekt, das vom qthelp-Builder generiert wurde und dazu führte, dass keine Inhalte im Qt-Assistenten angezeigt wurden.

  • #393: Korrigiert die Verwendung von Unicode-Zeichen in mathematischen Formeln bei Verwendung der pngmath Erweiterung.

  • #404: Stellt sicher, dass \and im Autorfeld der latex_documents Einstellung korrekt funktioniert.

  • #409: Stellt sicher, dass der highlight_language Konfigurationswert im LaTeX-Builder korrekt funktioniert.

  • #418: Ermöglicht die Verlagerung der JavaScript-Dateien für die Übersetzung in das Systemverzeichnis unter Unix-Systemen.

  • #414: Korrigiert die Behandlung von Windows-Zeilenumbrüchen in Dateien, die mit der literalinclude Direktive eingeschlossen wurden.

  • #377: Behebt einen Absturz im Linkcheck-Builder.

  • #387: Korrigiert die Anzeige von Suchergebnissen in der dirhtml Ausgabe.

  • #376: In autodoc, behebt die Anzeige von Standardparametern, die Backslashes enthalten.

  • #370: Korrigiert die Behandlung von komplexen Listenbezeichnungen in der LaTeX-Ausgabe.

  • #374: Stellt sicher, dass der doctest_path Konfigurationswert der doctest-Erweiterung tatsächlich funktioniert.

  • Korrigiert die Behandlung mehrerer Toctrees bei der Erstellung des globalen TOC für die toctree() Template-Funktion.

  • Korrigiert die Behandlung versteckter Toctrees bei der Erstellung des globalen TOC für die toctree() Template-Funktion.

  • Korrigiert die Behandlung verschachtelter Listen im Text-Writer.

  • #362: In autodoc, prüft auf die Existenz von __self__ bei Funktions-Objekten, bevor darauf zugegriffen wird.

  • #353: Entfernt führende und nachfolgende Leerzeichen beim Extrahieren von Suchwörtern in der Suchfunktion.

Release 0.6.5 (01. März 2010)

  • In autodoc, behebt die Auslassung einiger Modulmitglieder, die explizit mit Dokumentationskommentaren dokumentiert wurden.

  • #345: Korrigiert das Zuschneiden der Seitenleisten-Scrollleiste mit der stickysidebar Option des Standardthemas.

  • #341: Generiert immer UNIX-Zeilenumbrüche in der quickstart Makefile.

  • #338: Korrigiert die Ausführung mit -C unter Windows.

  • In autodoc, erlaubt die Anpassung der Signatur eines Objekts, bei dem der eingebaute Mechanismus fehlschlägt.

  • #331: Korrigiert die Ausgabe für nummerierte Listen mit Startwerten in LaTeX.

  • Stellt sicher, dass die Optionen start-after und end-before für die literalinclude Direktive korrekt funktionieren, auch wenn sie nicht zusammen verwendet werden.

  • #321: Korrigiert die Linkgenerierung im LaTeX-Builder.

Release 0.6.4 (12. Jan. 2010)

  • Verbessert die Handhabung von Nicht-Unicode-Strings in der Konfiguration.

  • #316: Fängt OSErrors ab, die beim Aufruf von Graphviz mit Argumenten auftreten, die es nicht versteht.

  • Stellt Kompatibilität mit Pygments >= 1.2 wieder her.

  • #295: Korrigiert das Escaping von Hyperref-Zielen in der LaTeX-Ausgabe.

  • #302: Korrigiert Links, die von der :doc: Rolle für die LaTeX-Ausgabe generiert werden.

  • #286: Sammelt Todo-Knoten, nachdem das gesamte Dokument gelesen wurde; dies ermöglicht die Platzierung von Substitutionsreferenzen in Todo-Elementen.

  • #294: Ignoriert keinen expliziten today Konfigurationswert in einem LaTeX-Build.

  • Der alt-Text von Vererbungdiagrammen ist jetzt viel sauberer.

  • Ignoriert Bilder in Abschnittsüberschriften bei der Generierung von Link-Beschriftungen.

  • #310: Unterstützt Fehlermeldungen in den testoutput Blöcken der doctest Erweiterung.

  • #293: Zeilenblöcke werden in der HTML-Ausgabe korrekt gestylt.

  • #285: Sorgt dafür, dass der locale_dirs Konfigurationswert wieder funktioniert.

  • #303: html_context Werte, die auf der Kommandozeile über -A angegeben werden, sollten andere Werte in conf.py nicht überschreiben.

  • Behebt einen Fehler, der inkrementelle Neubauten für den dirhtml-Builder verhinderte.

  • #299: Korrigiert das Mangling von Anführungszeichen in einigen Literalblöcken.

  • #292: Korrigiert den Pfad zum Suchindex für den dirhtml-Builder.

  • Behebt ein Jython-Kompatibilitätsproblem: die Abhängigkeit vom parser-Modul ist nun optional.

  • #238: In autodoc, fängt alle Fehler ab, die beim Modulimport auftreten, nicht nur ImportError.

  • Korrigiert die Behandlung von nicht-Daten, aber nicht-Methoden-Deskriptoren in autodoc.

  • Beim Kopieren von Datei-Zeitstempeln werden OSErrors ignoriert, die beim Aufruf von os.utime() auftreten.

Release 0.6.3 (03. Sep. 2009)

  • Fügt C-Modul-Dateinamen ordnungsgemäß als Abhängigkeiten in autodoc hinzu.

  • #253: Ignoriert Graphviz-Direktiven ohne Inhalt, anstatt eine unbehandelte Ausnahme auszulösen.

  • #241: Behebt einen Absturz beim Erstellen von LaTeX-Ausgaben für Dokumente, die eine todolist-Direktive enthalten.

  • #252: Vereinfacht die Änderung des Build-Verzeichnisses in den von quickstart generierten Makefiles.

  • #220: Korrigiert CSS, damit displaymath wirklich zentriert ist.

  • #222: Ermöglicht die Übersetzung der Kopfzeile „Fußnoten“.

  • #225: Fügt nach Inline-Tags in generiertem HTML keinen Leerraum ein.

  • #227: Sorgt dafür, dass literalinclude funktioniert, wenn der Pfadname des Dokuments Nicht-ASCII-Zeichen enthält.

  • #229: Behebt Autodoc-Fehler bei Mitgliedern, die Fehler bei getattr() auslösen.

  • #205: Beim Kopieren von Dateien werden nicht die vollständigen Stat-Infos kopiert, nur die Änderungszeiten.

  • #232: Unterstützt Nicht-ASCII-Metadaten im Qt-Hilfe-Builder.

  • Formatiert Aufzählungslisten, die in Definitionslisten verschachtelt sind, korrekt für LaTeX.

  • Abschnittsüberschriften sind jetzt innerhalb von only Direktiven erlaubt.

  • #201: Sorgt dafür, dass die centered Direktive in der LaTeX-Ausgabe funktioniert.

  • #206: Weigert sich, ein bestehendes Master-Dokument in sphinx-quickstart zu überschreiben.

  • #208: Verwendet MS-genehmigte Locale-Einstellungen, ermittelt durch die language Konfigurationsoption, im HTML-Hilfe-Builder.

  • #210: Korrigiert die Verschachtelung von HTML-Tags für angezeigte Mathematik aus der pngmath-Erweiterung.

  • #213: Korrigiert die Zentrierung von Bildern in der LaTeX-Ausgabe.

  • #211: Korrigiert die Kompatibilität mit Docutils 0.5.

Release 0.6.2 (16. Juni 2009)

  • #130: Behebt einen obskuren IndexError in der doctest-Erweiterung.

  • #167: Macht die Glossar-Sortierung unabhängig von der Groß-/Kleinschreibung.

  • #196: Fügt eine Warnung hinzu, wenn ein Erweiterungsmodul keine setup() Funktion hat.

  • #158: Erlaubt „..“ in Vorlagennamen und absolute Vorlagenpfade; Jinja 2 deaktiviert standardmäßig beides.

  • Beim Hervorheben von Python-Code wird zusätzliche Einrückung ignoriert, bevor versucht wird, sie als Python zu parsen.

  • #191: Maskiert die Tilde in URIs in LaTeX nicht.

  • Berücksichtigt den Inhalt von Quelltext-Kommentaren nicht für den Suchindex.

  • Setzt die Standardkodierung auf utf-8-sig, um Dateien mit einem UTF-8-BOM korrekt zu behandeln.

  • #178: Wendet den add_function_parentheses Konfigurationswert auf C-Funktionen an, wie versprochen.

  • #173: Beachtet die Docutils title Direktive.

  • #172: Die obj Rolle verlinkt nun mit Modulen, wie versprochen.

  • #19: Tabellen können jetzt eine „longtable“-Klasse haben, um korrekt in Seiten in der LaTeX-Ausgabe aufgeteilt zu werden.

  • Sucht nach Sphinx-Nachrichtenkatalogen im Systemstandardpfad, bevor sphinx/locale versucht wird.

  • Korrigiert die Suche nach Methoden über „klassenname.methodenname“.

  • #155: Behebt Python 2.4 Kompatibilität: Ausnahmen sind dort alte Klassen.

  • #150: Korrigiert die Anzeige des „sphinxdoc“-Themas im Internet Explorer Versionen 6 und 7.

  • #146: Schlägt nicht fehl, wenn der Benutzer eine aktive .docutils Konfiguration hat, wenn LaTeX generiert wird.

  • #29: Generiert keine sichtbaren „-{-}“ in Optionslisten in LaTeX.

  • Korrigiert Kreuzreferenzrollen, wenn sie in Substitutionen eingefügt werden.

  • Fügt den „alt“-Text von Bildern nicht in Inhaltsverzeichniseinträge ein.

  • Im LaTeX-Writer wird keine Ausnahme bei zu vielen Ebenen von Abschnittsüberschriften ausgelöst, es wird einfach die Ebene „subparagraph“ für alle verwendet.

  • #145: Behebt ein Autodoc-Problem mit automatischen Mitgliedern, die sich weigern, von ihrem Elternteil mit getattr() aufgerufen zu werden.

  • Wenn spezifische Dateinamen zum Erstellen auf der Kommandozeile angegeben werden, wird geprüft, ob sie sich innerhalb des Quellverzeichnisses befinden.

  • Behebt Autodoc-Absturz für Objekte ohne __name__.

  • Behebt InterSphinx für Installationen ohne urllib2.HTTPSHandler.

  • #134: Korrigiert überfällige xref-Knoten bei Verwendung der todolist-Direktive aus der todo-Erweiterung.

Release 0.6.1 (26. März 2009)

  • #135: Behebt Probleme mit der LaTeX-Ausgabe und der Graphviz-Erweiterung.

  • #132: Schließt die autosummary „module“-Vorlage in die Distribution ein.

Release 0.6 (24. März 2009)

Neue Funktionen hinzugefügt

  • Inkompatible Änderungen

    • Templating erfordert nun die Jinja2-Bibliothek, eine verbesserte Version der alten Jinja1-Engine. Da Syntax und Semantik weitgehend gleich sind, sollten nur wenige Korrekturen an benutzerdefinierten Vorlagen notwendig sein.

    • Das „document“-Div-Tag wurde aus dem „document“-Block der layout.html Vorlage verschoben, da das schließende Tag bereits außerhalb lag. Wenn Sie diesen Block überschreiben, müssen Sie auch Ihr „document“-Div-Tag entfernen.

    • Das autodoc_skip_member Event entscheidet nun auch, ob Mitglieder übersprungen werden sollen, deren Name mit Unterstrichen beginnt. Zuvor wurden diese Mitglieder immer automatisch übersprungen. Wenn Sie dieses Event behandeln, fügen Sie etwas Ähnliches wie folgt zu Ihrem Event-Handler hinzu, um das alte Verhalten wiederherzustellen

      if name.startswith('_'):
    return True

  • Theming-Unterstützung, siehe neuer Abschnitt in der Dokumentation.

  • Markup

    • Aufgrund vielfacher Nachfrage wurde eine :doc: Rolle hinzugefügt, die direkt auf ein anderes Dokument verweist, ohne dass ein Label erstellt werden muss, auf das eine :ref: verweisen könnte.

    • #4: Hinzugefügt wurde eine :download: Rolle, die eine Nicht-Dokument-Datei für die Aufnahme in die HTML-Ausgabe markiert und darauf verlinkt.

    • Hinzugefügt wurde eine only Direktive, die Text selektiv basierend auf aktivierten „Tags“ einschließen kann. Tags können auf der Kommandozeile angegeben werden. Außerdem ist das aktuelle Builder-Ausgabeformat (z. B. „html“ oder „latex“) immer ein definiertes Tag.

    • #10: Hinzugefügt wurden HTML-Abschnittsnummern, aktiviert durch ein :numbered: Flag für die toctree Direktive.

    • #114: Hinzugefügt wurde eine abbr Rolle zur Kennzeichnung von Abkürzungen und Akronymen.

    • Die literalinclude Direktive unterstützt nun mehrere weitere Optionen, um nur Teile einer Datei einzuschließen.

    • Die toctree Direktive unterstützt nun ein :hidden: Flag, das verhindert, dass Links anstelle der Direktive generiert werden – dies ermöglicht es Ihnen, Ihre Dokumentenstruktur zu definieren, aber die Links selbst zu platzieren.

    • #123: Die glossary Direktive unterstützt nun ein :sorted: Flag, das Glossareinträge alphabetisch sortiert.

    • Pfade zu Bildern, Literal-Include-Dateien und Download-Dateien können nun absolut sein (wie /images/foo.png). Sie werden als relativ zum obersten Quellverzeichnis behandelt.

    • #52: Es gibt jetzt eine hlist Direktive, die eine kompakte Liste erstellt, indem sie Elemente in mehrere Spalten aufteilt.

    • #77: Wenn eine Beschreibungs-Umgebung mit einer Info-Feldliste nur einen :param: Eintrag enthält, wird keine Aufzählungsliste generiert.

    • #6: Es werden keine redundanten <ul> für Top-Level-TOC-Tree-Elemente generiert, was zu einer visuellen Trennung von TOC-Einträgen führt.

    • #23: Hinzugefügt wurde eine classmethod Direktive zusammen mit method und staticmethod.

    • Skalierte Bilder erhalten nun einen Link zur unskalierten Version.

    • SVG-Bilder werden nun in HTML unterstützt (über <object> und <embed> Tags).

    • Eine toctree callable wurde zu den Vorlagen hinzugefügt, ebenso die Möglichkeit, externe Links in Toctrees einzubinden. Das Schlüsselwortargument „collapse“ gibt an, ob nur Unterelemente der aktuellen Seite angezeigt werden sollen. (Standardmäßig True.)

  • Konfiguration

    • Der neue Konfigurationswert rst_epilog kann reST enthalten, das an jede gelesene Quelldatei angehängt wird. Dies ist der richtige Ort für globale Substitutionen.

    • Der neue Konfigurationswert html_add_permalinks kann verwendet werden, um die generierten „Absatzzeichen“-Permalinks für jede Überschrift und jede Definitionsumgebung zu deaktivieren.

    • Der neue Konfigurationswert html_show_sourcelink kann verwendet werden, um die Links zu den reST-Quellen in der Seitenleiste zu deaktivieren.

    • Der Standardwert für htmlhelp_basename ist nun der Projekttitel, bereinigt als Dateiname.

    • Der neue Konfigurationswert modindex_common_prefix kann verwendet werden, um bestimmte Paketnamen für die Sortierung des Modulindexes zu ignorieren.

    • Der neue Konfigurationswert trim_footnote_reference_space spiegelt den gleichnamigen Docutils-Konfigurationswert wider und entfernt den Leerraum vor einer Fußnotenreferenz, der für reST zur Erkennung der Referenz erforderlich ist.

    • Der neue Konfigurationswert latex_additional_files kann verwendet werden, um Dateien (die Sphinx nicht automatisch kopiert, z. B. wenn sie in benutzerdefiniertem LaTeX in latex_elements referenziert werden) in das Build-Verzeichnis zu kopieren.

  • Builder

    • Der HTML-Builder speichert nun eine kleine Datei namens .buildinfo in seinem Ausgabeverzeichnis. Dort wird ein Hash von Konfigurationswerten gespeichert, der verwendet werden kann, um festzustellen, ob ein vollständiger Neubau erforderlich ist (z. B. nach Änderung von html_theme).

    • Neuer Builder für Qt-Hilfesammlungen, von Antonio Valentino.

    • Der neue DirectoryHTMLBuilder (Kurzname dirhtml) erstellt ein separates Verzeichnis für jede Seite und platziert die Seite dort in einer Datei namens index.html. Daher müssen Seiten-URLs und Links keine .html enthalten.

    • Der neue Konfigurationswert html_link_suffix kann verwendet werden, um die Endung von generierten Links zwischen HTML-Dateien auszuwählen.

    • #96: Der LaTeX-Builder unterstützt nun Grafiken, die von Text umschlossen sind, wenn die Option figwidth und eine rechts-/linksbündige Ausrichtung verwendet werden.

  • Neue Übersetzungen

    • Italienisch von Sandro Dentella.

    • Ukrainisch von Petro Sasnyk.

    • Finnisch von Jukka Inkeri.

    • Russisch von Alexander Smishlajev.

  • Erweiterungen und API

    • Neue graphviz Erweiterung zum Einbetten von Graphviz-Graphen.

    • Neue inheritance_diagram Erweiterung zum Einbetten von… Vererbungdiagrammen!

    • Neue autosummary Erweiterung, die Zusammenfassungen von Modulen und automatische Dokumentation von Modulen generiert.

    • Autodoc verfügt nun über eine wiederverwendbare Python-API, die zur Erstellung benutzerdefinierter Objekttypen zur automatischen Dokumentation (z. B. Zope-Schnittstellen) verwendet werden kann. Siehe auch Sphinx.add_autodocumenter().

    • Autodoc verarbeitet nun auch dokumentierte Attribute.

    • Autodoc verarbeitet nun auch innere Klassen und ihre Methoden.

    • Autodoc kann Klassen nun als Funktionen dokumentieren, wenn sie explizit mit autofunction markiert sind.

    • Autodoc kann nun einzelne Mitglieder über die Option exclude-members von der Dokumentation ausschließen.

    • Autodoc kann Mitglieder nun entweder alphabetisch (wie bisher) oder nach Mitgliedstyp sortieren; konfigurierbar entweder mit dem Konfigurationswert autodoc_member_order oder einer member-order Option pro Direktive.

    • Die Funktion Sphinx.add_directive() unterstützt nun auch Direktivenklassen im Docutils 0.5-Stil. Wenn sie von sphinx.util.compat.Directive erbt, funktionieren sie auch mit Docutils 0.4.

    • Es gibt nun eine Methode Sphinx.add_lexer(), um benutzerdefinierte Pygments-Lexer einfach verwenden zu können.

    • Es gibt nun Sphinx.add_generic_role(), um die gleichnamige Funktion von Docutils zu spiegeln.

  • Weitere Änderungen

    • Konfigurationsüberschreibungen für einzelne Wörterbuchschlüssel können nun auf der Kommandozeile angegeben werden.

    • Es gibt nun einen Konfigurationswert doctest_global_setup, der verwendet werden kann, um Setup-Code für alle Doctests in der Dokumentation bereitzustellen.

    • Quellcode-Links in HTML werden nun mit rel="nofollow" generiert.

    • Quickstart kann nun eine Windows make.bat Datei generieren.

    • #62: Es gibt nun eine -w Option für sphinx-build, die Warnungen zusätzlich zu stderr in eine Datei schreibt.

    • Es gibt nun eine -W Option für sphinx-build, die Warnungen in Fehler umwandelt.