Add support for 'changelog' generation in API documentation automated process on the buildbot. #97663
Labels
No Label
legacy module
Development Management
legacy module
Platforms, Builds, Tests & Devices
legacy module
Python API
legacy module
Rendering & Cycles
legacy project
3.3
legacy project
Development Management
legacy project
Documentation
legacy project
Infrastructure: Blender Buildbot
legacy project
Infrastructure: Websites
legacy project
Platform: macOS
legacy project
Platforms, Builds, Tests & Devices
legacy project
Platform: Windows
legacy project
Python API
legacy project
Render & Cycles
Priority::Low
Priority::Normal
Priority::Unbreak Now!
Status::Archived
Status::Confirmed
Status::Duplicate
Status::Needs Information from Developers
Status::Needs Triage
Status::Resolved
Type::Bug
Type::Report
Type::To Do
No Milestone
No project
No Assignees
8 Participants
Due Date
No due date set.
Dependencies
No dependencies set.
Reference: archive/blender-buildbot#97663
Loading…
Reference in New Issue
Block a user
No description provided.
Delete Branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
The 'changelog' page of the Blender API documetation used to be generated manually as a separate, independent step, prior to the actual API doc generation.
Now that the API doc is generated automatically on the buildbots as part of the build process, the change log generation needs to be integrated there as well.
After talking with @Arnd, here is the proposal:
py
file storage to a JSON format, to avoid having potentially executable files on the server.sphinx_doc_gen.py
):Generate the changelog page based on the diff between the two API dump files
ORIGINAL REPORT:
blender_python_reference/change_log shows changes from 2.83 to 2.90 in 3.1 / 3.2 release
System Information
Operating system: Windows-10-10.0.19043-SP0 64 Bits
Graphics card: NVIDIA GeForce GTX 1050/PCIe/SSE2 NVIDIA Corporation 4.5.0 NVIDIA 511.65
Blender Version
Broken: version: 3.1.2, branch: master, commit date: 2022-03-31 17:40, hash:
blender/blender@cc66d1020c
Worked: (newest version of Blender that worked as expected)
Short description of error
It appears that the python change-log information is not being updated.
Exact steps for others to reproduce the error
Go to Help >> Python API Reference
a web page is displayed, click on Change Log link
taken to https://docs.blender.org/api/3.1/change_log.html
In the title it says:
Added subscriber: @jamestomk
blender/documentation#98757 was marked as duplicate of this issue
Added subscriber: @lichtwerk
Can confirm.
Changed status from 'Needs Triage' to: 'Confirmed'
Added subscribers: @mont29, @ideasman42
@ideasman42 , @mont29 : do you know if this was done by hand?
The changelog generator needs to be run manually. The main reason this wasn't automated is you need two different Blender versions of generate output, although if we kept the previous releases output in a fixed location we could compare against that which will work as long as the file format doesn't change.
blender_python_reference/change_log shows changes from 2.83 to 2.90 in 3.1.0 releaseto blender_python_reference/change_log shows changes from 2.83 to 2.90 in 3.1 / 3.2 releaseAdded subscriber: @EAW
Will raise prio here since this is not a nice thing to have.
Added subscribers: @Arnd, @dmcgrath
I believe this was intentional, at least temporarily.
@Arnd and I were speaking in chat on matters relating to a recent buildbot problem, when he mentioned:
I expect that at some point he will move it back to the proper versions, after he has got to the bottom of the build issue he was looking into.
Guess what: the python manual suffers from the same deficiency.
This , at first glance, does not seem to be a buildbot related thing. The files that are produced in the build-steps are being delivered properly.
The remark above was related to the failure of the 3.2-upload process to adapt the 'current' and 'latest' links in docs. That's been fixed.
The Python changelog not being updated is something that, to me, looks to be part of the python-api-build-process itself. I'll look to see if I can see where exactly that is happening.
My intuition tells me it's not a buildbot issue.
Think this was indeed never integrated in the automated API doc generation process.... Will look into how to do that locally first, then we can work with @Arnd into integrating it to the buildbot system.
blender_python_reference/change_log shows changes from 2.83 to 2.90 in 3.1 / 3.2 releaseto Add support for 'changelog' generation in API documentation automated process on the buildbot.Added subscriber: @Blendify
I will be looking into this and discuss a solution with Cambell and Arnd.
@Blendify sorry it wasn't clear enough, am already working on this...
Changed status from 'Confirmed' to: 'Resolved'
This should now be resolved for current releases (2.93 LTS, 3.2 and future 3.3).