Skip to content

docs: publish objects.inv for Intersphinx - #331

Open
G-Glitch404 wants to merge 1 commit into
lundberg:masterfrom
G-Glitch404:fix/305-objects-inventory
Open

G-Glitch404 wants to merge 1 commit into
lundberg:masterfrom
G-Glitch404:fix/305-objects-inventory

Conversation

@G-Glitch404

Copy link
Copy Markdown

Summary

Add Sphinx-compatible objects.inv generation to the MkDocs documentation build.

This allows projects using Sphinx/Intersphinx to resolve and link to RESpx API objects such as respx.Router and respx.MockRouter.

Changes

  • Replace mkautodoc with mkdocstrings[python]
  • Enable Sphinx inventory generation
  • Add a dedicated API objects documentation page
  • Add an inventory validation Nox session
  • Run the inventory validation as part of the documentation workflows
  • Update documentation workflow path filters so relevant documentation changes trigger the build

Validation

The documentation build succeeds, and the generated site/objects.inv is checked for respx.Router and respx.MockRouter.

Closes #305

@G-Glitch404
G-Glitch404 marked this pull request as ready for review October 1, 2026 17:35

This branch has not been deployed

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Publish objects.inv for Sphinx/mkdocstrings intersphinx

1 participant