lark-parser/lark

HTML documentation is not built reproducibly (Sphinx)

Open

#722 建立於 2020年10月16日

在 GitHub 查看
 (10 留言) (0 反應) (0 負責人)Python (4,275 star) (384 fork)batch import
help wanted

描述

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.

貢獻者指南

技術棧
python
領域
documentation
議題類型
bug
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
under 1 hour
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
basic knowledge of SphinxPython
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
85
研究方向
The issue identifies that Sphinx's default `html copy source=True` causes build paths to be embedded in source files, breaking reproducibility. The fix is to set `html copy source = False` in `docs/conf.py`. Before implementing, verify that no other documentation features rely on source copying, such as the ` sources` directory. After the change, rebuild the docs and check that the build paths are absent.