lark-parser/lark

HTML documentation is not built reproducibly (Sphinx)

Open

#722 geöffnet am 16. Okt. 2020

Auf GitHub ansehen
 (10 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (384 Forks)batch import
help wanted

Repository-Metriken

Stars
 (4.275 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 41m) (1 gemergte PR in 30 T)

Beschreibung

The present sphinx configuration leads to sources being included in the html build inside the _sources directory (because html_copy_source is set to true by default). Inside this directory the file _sources/examples/index.rst.txt contains the build path, e. g. for one of my builds:

[...]
    :download:`Download all examples in Python source code: examples_python.zip <//build/python-lark-utTVdH/python-lark-0.10.0/docs/examples/examples_python.zip>`
[...]
    :download:`Download all examples in Jupyter notebooks: examples_jupyter.zip <//build/python-lark-utTVdH/python-lark-0.10.0/docs/examples/examples_jupyter.zip>`
[...]

This renders the HTML documentation build process unreproducible (see https://reproducible-builds.org).

Is there a particular reason why you include the sources in the html build? If the only reason is that this behaviour is the default, one possible way to fix this would be setting

html_copy_source = False

in docs/conf.py.

Contributor Guide

Research-Richtung
Überprüfen Sie die Sphinx Konfiguration in 'docs/conf.py' und setzen Sie 'html copy source = False', um zu verhindern, dass Build Pfade in der HTML Ausgabe enthalten sind.
Tech Stack
python
Domain
documentationbuild system
Issue Type
Fehler
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitPythonSphinx
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90