lark-parser/lark

HTML documentation is not built reproducibly (Sphinx)

Open

#722 opened on 2020年10月16日

GitHub で見る
 (10 comments) (0 reactions) (0 assignees)Python (4,275 stars) (384 forks)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
Issue 種別
bug
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
under 1 hour
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.