Add discoverability metadata - #1067
Merged
Merged
Conversation
Add PyPI keywords and project URLs, a CITATION.cff for the Nature Methods article, and an llms.txt that Read the Docs serves from the domain root. Enable sphinxext-opengraph, which was already a documentation dependency with ogp_* configuration in place but was never added to extensions, and set html_baseurl so that canonical URLs point at the default version instead of every version competing as duplicate content.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1067 +/- ##
==========================================
+ Coverage 74.15% 78.72% +4.56%
==========================================
Files 52 52
Lines 7291 7290 -1
==========================================
+ Hits 5407 5739 +332
+ Misses 1884 1551 -333 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Makes pertpy easier to find for search engines, LLM agents and citation tooling.
PyPI — adds
keywordsand Issues / Changelog / Forum / Publication project URLs.CITATION.cff — enables GitHub's "Cite this repository" button and lets citation tooling resolve the Nature Methods article. Validated against schema 1.2.0 with
cffconvert.Docs
sphinxext-opengraphwas already adocdependency withogp_site_urlandogp_imageconfigured, but was never added toextensions. The live docs therefore serve no OpenGraph tags and no meta description at all.html_baseurlis now taken fromREADTHEDOCS_CANONICAL_URL. Because the build uses custombuild.jobscommands, Read the Docs does not inject a canonical URL itself, so/en/latest/,/en/stable/and all nine tagged versions currently compete as duplicate content.docs/llms.txtis served by Read the Docs from the root of the domain and gives agents a curated map of the API and tutorials. Every symbol it names was checked againstpertpy.tools.__all__.<title>is no longerpertpy — pertpy.hatch run docs:build(which passes-W) builds clean, and the output contains canonical links, OpenGraph tags and meta descriptions on every page.Repository topics were separately expanded from 3 to 13 in the repository settings; that is not part of this diff.