Skip to content

Add Python stdlib and dependency cross-references (objects.inv inventories) #113

Description

@Alberto-Codes

Problem

The API reference docs don't link stdlib types (e.g., typing.Protocol, asyncio.to_thread, bytes) or external dependency types (e.g., google.adk.sessions.BaseSessionService, cryptography.fernet.Fernet) to their upstream documentation. Docvet has this via mkdocstrings inventories — we should match.

Solution

Add inventories to the mkdocstrings handler in mkdocs.yml:

inventories:
  - https://docs.python.org/3/objects.inv

Additionally, investigate objects.inv availability for direct dependencies:

Acceptance Criteria

  • Stdlib types in API reference link to docs.python.org
  • External dependency types link to their upstream docs where objects.inv is available
  • mkdocs build --strict still passes

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions