Skip to content

Update pydoctor#12384

Merged
adiroiban merged 7 commits intotwisted:trunkfrom
tristanlatr:update-pydoctor
Dec 10, 2024
Merged

Update pydoctor#12384
adiroiban merged 7 commits intotwisted:trunkfrom
tristanlatr:update-pydoctor

Conversation

@tristanlatr
Copy link
Contributor

@tristanlatr tristanlatr commented Dec 6, 2024

Scope and purpose

  • Update pydoctor to at least 24.11.0.
  • Fixes the "Go to the latest version of this document." links.
  • Use the new pydoctor option --html-base-url.
  • Remove google analytics from the API docs.

@codspeed-hq
Copy link

codspeed-hq bot commented Dec 6, 2024

CodSpeed Performance Report

Merging #12384 will not alter performance

Comparing tristanlatr:update-pydoctor (db25cc4) with trunk (a0175bb)

Summary

✅ 34 untouched benchmarks

@tristanlatr tristanlatr requested a review from a team December 6, 2024 19:28
}
</script>

<script src="stable-link.js" type="text/javascript"></script>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Happy to see the google analytics removed.


Just asking

Does moving the script to a separate file improves the performance ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don’t believe it particularly improves performance, no

Copy link
Member

@adiroiban adiroiban left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the changes

I have reviewed the result at https://twisted--12384.org.readthedocs.build/en/12384/api/twisted.logger.html

I prefer to pin the pydoctor dependency.


This needs to have a src/twisted/newsfragments/12384.misc to let our release notes processing tools know that it should not expect a public release for this PR


Other than that, only minor comments

While reviewing, I have observed something that is not specific to this PR. The issue is also found on trunk.

The source links for the stable branch are alwasy to HEAD, instead of linking to the branch.

Most probably this is not a pydoctor issue, but an issue with the way we build the api docs

tristanlatr and others added 2 commits December 9, 2024 21:20
@tristanlatr
Copy link
Contributor Author

Are we good here ?

@tristanlatr
Copy link
Contributor Author

The source links for the stable branch are alwasy to HEAD, instead of linking to the branch.

This is true only for the tox environment, for the production Twisted uses correct paths:

f"--html-viewsource-base=https://github.com/twisted/twisted/tree/{_git_reference}/src",

@adiroiban
Copy link
Member

This needs to have a src/twisted/newsfragments/12384.misc to let our release notes processing tools know that it should not expect a public release for this PR

Other than that, I think that this is ready to merge.

Thanks for the update!

@adiroiban adiroiban merged commit 0e665d6 into twisted:trunk Dec 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants