Opened 6 years ago

Closed 6 years ago

#19858 closed enhancement (fixed)

Reproducible documentation build

Reported by: jdemeyer Owned by:
Priority: major Milestone: sage-7.0
Component: documentation Keywords:
Cc: Merged in:
Authors: Jeroen Demeyer Reviewers: Volker Braun
Report Upstream: N/A Work issues:
Branch: 941a0f2 (Commits, GitHub, GitLab) Commit: 941a0f22b93594f96c3b243542e6288756c751bd
Dependencies: Stopgaps:

Status badges

Description (last modified by jdemeyer)

Building twice the documentation from the same sources should produce the exact same result, byte for byte. This requires removing hexadecimal addresses like function <lambda> at 0xdeadbeef.

This will make it easier to diff docs to review doc-related tickets.

With the branch applied, the only source of non-reproducibility is this one:

  • en/reference/finance/sage/finance/stock.html

    diff -ru html1/en/reference/finance/sage/finance/stock.html html2/en/reference/finance/sage/finance/stock.html
    old new  
    271271
    272272<dl class="method">
    273273<dt id="sage.finance.stock.Stock.history">
    274 <tt class="descname">history</tt><big>(</big><em>startdate='Jan+1</em>, <em>+1900'</em>, <em>enddate='Jan+14</em>, <em>+2016'</em>, <em>histperiod='daily'</em><big>)</big><a class="headerlink" href="#sage.finance.stock.Stock.history" title="Permalink to this definition">¶</a></dt>
     274<tt class="descname">history</tt><big>(</big><em>startdate='Jan+1</em>, <em>+1900'</em>, <em>enddate='Jan+15</em>, <em>+2016'</em>, <em>histperiod='daily'</em><big>)</big><a class="headerlink" href="#sage.finance.stock.Stock.history" title="Permalink to this definition">¶</a></dt>
    275275<dd><p>Return an immutable sequence of historical price data
    276276for this stock, obtained from Google. OHLC data is stored
    277277internally as well. By default, returns the past year&#8217;s daily

Change History (5)

comment:1 Changed 6 years ago by jdemeyer

  • Branch set to u/jdemeyer/reproducible_documentation_build

comment:2 Changed 6 years ago by jdemeyer

  • Authors set to Jeroen Demeyer
  • Commit set to 941a0f22b93594f96c3b243542e6288756c751bd
  • Status changed from new to needs_review

New commits:

941a0f2Remove hexadecimal addresses from argspec

comment:3 Changed 6 years ago by jdemeyer

  • Description modified (diff)

comment:4 Changed 6 years ago by vbraun

  • Reviewers set to Volker Braun
  • Status changed from needs_review to positive_review

comment:5 Changed 6 years ago by vbraun

  • Branch changed from u/jdemeyer/reproducible_documentation_build to 941a0f22b93594f96c3b243542e6288756c751bd
  • Resolution set to fixed
  • Status changed from positive_review to closed
Note: See TracTickets for help on using tickets.