HTML documentation is not built reproducibly (Sphinx)
See original GitHub issueThe 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
.
Issue Analytics
- State:
- Created 3 years ago
- Comments:10 (10 by maintainers)
Top Results From Across the Web
html file created by sphinx does not have any documentation
The solution in this case was to add extensions = ['sphinx. ext. autodoc'] to the conf.py file.
Read more >Changelog - Sphinx documentation
Please notice it changes the output of HTML builder. Some themes do not support it, and you need to update your custom CSS...
Read more >Reproducible Builds - Read the Docs
Your docs depend on tools and other dependencies to be built. If your docs don't have reproducible builds, an update in a dependency...
Read more >#921513 - sphinx: please make the build reproducible
Package: src:sphinx; Maintainer for src:sphinx is Debian Python Team ... meant that builds of documentation were not independent of where on ...
Read more >6. Documentation - Python Packages
The reality is, if no one knows how to use your package, it will probably not get used! ... 6.1 Example of HTML...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
@chsasank: Could you please elaborate why you think this solves the issue?
You can dockerize the build so that it’s completely reproducible.