Sphinx 6.0

Release 6.0.1 (veröffentlicht am 05. Jan 2023)

Abhängigkeiten

  • Pygments 2.13 oder neuer erforderlich.

Behobene Fehler

  • #10944: imgmath: Korrigieren der Auflösung von Bildpfaden für Dateien in verschachtelten Ordnern.

Release 6.0.0 (veröffentlicht am 29. Dez 2022)

Abhängigkeiten

  • #10468: Unterstützung für Python 3.6 eingestellt

  • #10470: Unterstützung für Python 3.7, Docutils 0.14, Docutils 0.15, Docutils 0.16 und Docutils 0.17 eingestellt. Patch von Adam Turner

Inkompatible Änderungen

  • #7405: Die JavaScript-Frameworks jQuery und underscore.js wurden entfernt.

    Diese Frameworks werden ab Sphinx 6.0 nicht mehr automatisch in Themes injiziert. Wenn Sie ein Theme oder eine Erweiterung entwickeln, die die globalen Objekte jQuery, $ oder $u verwendet, müssen Sie Ihr JavaScript auf moderne Standards aktualisieren oder die unten stehende Abhilfemaßnahme verwenden.

    Die erste Option ist die Verwendung der Erweiterung sphinxcontrib.jquery, die vom Sphinx-Team und Mitwirkenden entwickelt wurde. Um diese zu verwenden, fügen Sie sphinxcontrib.jquery zur Liste extensions in conf.py hinzu oder rufen Sie app.setup_extension("sphinxcontrib.jquery") auf, wenn Sie ein Sphinx-Theme oder eine Sphinx-Erweiterung entwickeln.

    Die zweite Option ist die manuelle Sicherstellung, dass die Frameworks vorhanden sind. Um jQuery und underscore.js wieder hinzuzufügen, müssen Sie jquery.js und underscore.js aus dem Sphinx-Repository in Ihr static-Verzeichnis kopieren und Folgendes zu Ihrer layout.html hinzufügen:

    {%- block scripts %}
        <script src="{{ pathto('_static/jquery.js', resource=True) }}"></script>
        <script src="{{ pathto('_static/underscore.js', resource=True) }}"></script>
        {{ super() }}
    {%- endblock %}
    

    Patch von Adam Turner.

  • #10471, #10565: Entfernte veraltete APIs, die für die Entfernung in Sphinx 6.0 vorgesehen waren. Einzelheiten finden Sie unter Veraltete APIs. Patch von Adam Turner.

  • #10901: C-Domäne: Entfernen der Unterstützung für das Parsen von Typdirektiven und -rollen im Pre-v3-Stil. Entfernen Sie auch die zugehörigen Konfigurationsvariablen c_allow_pre_v3 und c_warn_on_allowed_pre_v3. Patch von Adam Turner.

Hinzugefügte Funktionen

Behobene Fehler

  • #10984: LaTeX: Dokumentation des Verhaltens von latex_additional_files für Dateien mit der Erweiterung .tex.