Sphinx 0.3

Release 0.3 (6. Mai 2008)

Neue Funktionen hinzugefügt

  • Die toctree-Direktive unterstützt jetzt eine glob-Option, die glob-ähnliche Einträge im Inhalt erlaubt.

  • Wenn der pygments_style-Konfigurationswert einen Punkt enthält, wird er als Importpfad einer benutzerdefinierten Pygments-Stilklasse behandelt.

  • Ein neuer Konfigurationswert, exclude_dirs, kann verwendet werden, um ganze Verzeichnisse von der Suche nach Quelldateien auszuschließen.

  • Das Konfigurationsverzeichnis (enthält conf.py) kann nun unabhängig vom Quellverzeichnis festgelegt werden. Dazu wurde eine neue Kommandozeilenoption -c hinzugefügt.

  • Eine neue Direktive tabularcolumns kann verwendet werden, um eine Tabellenspalten-Spezifikation für LaTeX-Ausgabe zu geben. Tabellen verwenden nun das tabulary-Paket. Literalblöcke können nun in Tabellen platziert werden, mit einigen Einschränkungen.

  • Ein neuer Konfigurationswert, latex_use_parts, kann verwendet werden, um Teile in LaTeX-Dokumenten zu aktivieren.

  • Autodoc überspringt nun geerbte Member für Klassen, es sei denn, Sie geben die neue inherited-members-Option an.

  • Ein neuer Konfigurationswert, autoclass_content, wählt aus, ob der Docstring der __init__-Methode der Klasse zum Körper der Direktive hinzugefügt wird.

  • Unterstützung für C++-Klassennamen (im Stil Class::Function) in C-Funktionsbeschreibungen.

  • Unterstützung für ein toctree_only-Element in Einträgen für den latex_documents-Konfigurationswert. Dies schließt nur die vom TOC-Baum referenzierten Dokumente in der Ausgabe ein, nicht den Rest der Datei, die die Direktive enthält.

Behobene Fehler

  • sphinx.htmlwriter: Korrektes Schreiben der TOC-Datei für jede Struktur des Master-Dokuments. Außerdem Kodierung von Nicht-ASCII-Zeichen als Entitäten in TOC- und Indexdateien. Entfernung von zwei verbleibenden hart kodierten Instanzen von „documentation“.

  • sphinx.ext.autodoc: Deskriptoren werden nun korrekt erkannt.

  • sphinx.latexwriter: Implementierung aller reST-Ermahnungen, nicht nur note und warning.

  • Viele kleine Korrekturen an der LaTeX-Ausgabe und dem Stil.

  • Korrektur der OpenSearch-Vorlage und Umwandlung der Vorlagen-URL in eine absolute URL. Der html_use_opensearch-Konfigurationswert muss nun die Basis-URL angeben.

  • Einige ungenutzte Dateien werden nun aus dem Build der HTML-Hilfedatei entfernt.