docs(seo): host the full PytorchWildlife API reference on the framework site#18
Open
rain-Brian wants to merge 2 commits into
Open
docs(seo): host the full PytorchWildlife API reference on the framework site#18rain-Brian wants to merge 2 commits into
rain-Brian wants to merge 2 commits into
Conversation
…k docs site Migrate the auto-generated API reference (mkdocstrings) to the framework's own documentation site, so PyTorch-Wildlife hosts the complete code API rather than the Biodiversity hub. Pairs the hand-written API Overview with a per-module reference. - Enable the mkdocstrings python handler with paths: [src] (this repo uses a src/ layout) and google docstrings. - Add the 32-page Reference - Code API nav tree (base module: data, models, utils; plus model fine-tuning), mirroring the structure the hub previously carried. Verified: mkdocs build renders the reference from src/PytorchWildlife (static analysis); sitemap grew from 6 to 40 URLs.
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
1 participant
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.
What
Migrates the auto-generated API reference (mkdocstrings) to PyTorch-Wildlife's own docs site, so the framework's complete code API lives at the framework home rather than on the Biodiversity hub. This is the prerequisite for cleanly removing the leftover package copy from the hub without losing that content from the cluster.
Changes
paths: [src](this repo uses a src/ layout) + google docstrings.Verification
mkdocs buildrenders the reference fromsrc/PytorchWildlifevia griffe static analysis (no runtime import / torch needed); the datasets page shows real symbols (ClassificationImageFolder,DetectionImageFolder).Stacking
Stacked on the content PR #16 (base
seo/pw-content; retargets to main when #16 merges). Pairs with the hub removal draft, which depends on this landing first.Part of resolving the hub/framework duplication (ADO Epic 506340). No reviewer set per current instruction.