Thanks for the clarification.
You have provided a lot of useful details. There are a lot of interconnected pieces, with multiple people working on different things.
For now, I am going to proceed to finish the release as-is.
The documentation may not be automatically deployed as part of the release, but I think that can be done as a follow-on task. -- Craig
On Sat, Feb 27, 2021 at 4:53 PM Adi Roiban email@example.com wrote:
Sorry for the delay.
We did the automation and Read The Docs hosting.
In parallel there was also the work required to host the pydoctor API docs on Read The Docs.
Note that https://docs.twistedmatrix.com/en/twisted-20.3.0/api 404
That should host the files from https://twistedmatrix.com/documents/current/api/
For `trunk` we have https://docs.twistedmatrix.com/en/latest/api/
That was the hard work done by Maarten to improve pydoctor and Twisted API docs.
There was a plan to do a new pydoctor release over the end of the year break... but that never happened.
The current PR that is "breaking" API links from narrative docs to API docs on Read The Docs version of Twisted docs is https://github.com/twisted/twisted/pull/1496
But even before that PR the API docs on Read the Docs were broken, as we had too many HTML pages and the build process on RTD was interrupted.
This is why I have approved the PR in the first place.
So https://github.com/twisted/twisted/pull/1466 should also be reverted
So, if for this release the "official" Twisted documentation is to be hosted at https://twistedmatrix.com/documents/current/api/ then https://twistedmatrix.com/trac/ticket/10068 is not a blocker.
If the plan is to host the full and "official" Twisted documentation on Read The Docs, the https://twistedmatrix.com/trac/ticket/10068 is a blocker.
And the easiest solution is to do a new pydoctor release.
I will try to follow up with Maarten over IRC to see if we can get a new pydoctor release.
In theory, the pydoctor release process is automated and any other Twisted developer from https://github.com/orgs/twisted/teams/twisted-contributors could do a release.
Maarten did the release work in the recent past but if he is busy, in theory anyone could step in and help with a new pydoctor release.
On Sat, 20 Feb 2021 at 17:47, Craig Rodrigues firstname.lastname@example.org wrote:
I am confused. I thought that you and Thomas Graingert had completed all the automation and had changed the Twisted release scripts to host the documentation on readthedocs and that was all in place right now.
Is that not the case?
How much more work is necessary to completely host the next Twisted release's docs on readthedocs?
On Saturday, February 20, 2021, Adi Roiban email@example.com wrote:
Sorry for the delay.
This was added as a blocker due to the changes from https://github.com/twisted/twisted/pull/1496 and the plan to use Read The Docs to host the official docs.
This is not a blocker if the official documentation for this release will continue to be hosted on the Twisted own server at https://twistedmatrix.com/documents/current/
It's a blocker only if the official documentation is to be hosted on Read The Docs at docs.twistedmatrix.com
I have updated the ticket to no longer block the release.
On Sat, 20 Feb 2021 at 02:08, Craig Rodrigues firstname.lastname@example.org wrote:
Is there anything to be done here, or is this still a release blocker?
On Sun, Feb 14, 2021 at 4:15 PM Craig Rodrigues email@example.com wrote:
This ticket: Use latest pydoctor release, https://twistedmatrix.com/trac/ticket/10068
is marked as a release blocker.
Has that been resolved or is there more work that needs to be done to fix that?
-- Adi Roiban
-- Adi Roiban