Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ensure the graphviz filenames are reproducible #6028

Closed
wants to merge 1 commit into from

Commits on Feb 6, 2019

  1. Ensure the graphviz filenames are reproducible.

    Whilst working on the Reproducible Builds effort [0], we noticed
    that sphinx could generate output that is not reproducible.
    
    In particular, the graphviz extension module would construct
    filenames based on, inter alia, the contents of the `options`
    dictionary.
    
    As this contained the absolute build path of the source file
    embedded in the `docname` variable this meant that builds of
    documentation were not independent of where on a filesystem they
    were built from.
    
    Example filenames might be:
    
      -  html/_images/graphviz-9e71e0f9ba91d0842b51211b676ec4adb7e7afb8.png
      +  html/_images/graphviz-6241bbfd7ac6bd4e2ad9af451ab0dfb8719988d2.png
    
    We fix this by limiting how much of the `docname` variable ends up
    in the final constructed filename; I assume there is a good reason
    for including the `options` dictionary in the first place, otherwise
    we could simply omit it.
    
      [0] https://reproducible-builds.org
    lamby committed Feb 6, 2019
    Configuration menu
    Copy the full SHA
    1a4362b View commit details
    Browse the repository at this point in the history