Page MenuHome
Differential D14429

API doc: Tweak sphinx to get date of source commit instead of build date.
ClosedPublic
Actions

Authored by Bastien Montagne (mont29) on Mar 23 2022, 3:27 PM.

Details

Reviewers
Dalai Felinto (dfelinto)
Arnd Marijnissen (Arnd)
Campbell Barton (campbellbarton)
Commits
rB1ec93507e130: API doc: Tweak sphinx to get date of source commit instead of build date.
Summary

This commit disables the 'last updated' value (which is the date the
sphinx doc is generated), and instead modifies the 'commit' field from
the 'html_context' data to get:

  • a link to the commit itself.
  • the date of that commit.

This avoids having the whole documentation detected as changed every
time it is re-generated by the buildbot.

Diff Detail

Repository
rB Blender
Branch
tmp (branched from master)
Build Status
Buildable 21205
Build 21205: arc lint + arc unit

Event Timeline

Bastien Montagne (mont29) requested review of this revision.Mar 23 2022, 3:27 PM
Bastien Montagne (mont29) created this revision.
Harbormaster completed remote builds in B21205: Diff 49590.Mar 23 2022, 3:27 PM
Bastien Montagne (mont29) edited the summary of this revision. (Show Details)Mar 23 2022, 3:28 PM
Dalai Felinto (dfelinto) accepted this revision.Mar 23 2022, 3:45 PM
This revision is now accepted and ready to land.Mar 23 2022, 3:45 PM
Aaron Carlisle (Blendify) added a subscriber: Aaron Carlisle (Blendify).Mar 23 2022, 7:05 PM
Aaron Carlisle (Blendify) added inline comments.
doc/python_api/sphinx_doc_gen.py
1765–1766

This can be removed, the default value is none.

Bastien Montagne (mont29) added inline comments.Mar 24 2022, 8:38 AM
doc/python_api/sphinx_doc_gen.py
1765–1766

I would still keep it, would rather be explicit here.

Campbell Barton (campbellbarton) accepted this revision.Mar 24 2022, 12:46 PM
Closed by commit rB1ec93507e130: API doc: Tweak sphinx to get date of source commit instead of build date. (authored by Bastien Montagne (mont29)). · Explain WhyApr 6 2022, 11:44 AM
This revision was automatically updated to reflect the committed changes.
Bastien Montagne (mont29) added a commit: rB1ec93507e130: API doc: Tweak sphinx to get date of source commit instead of build date..

Revision Contents
Changeset List

PathSize
doc/
python_api/
11 lines

Diff 49590

View Options

doc/python_api/sphinx_doc_gen.py

Loading...