Docs/mkdocs material rtd#11
Open
nseetim wants to merge 4 commits into
Open
Conversation
Return validated instances from DANJAResource/DANJAResourceList wrap validators to comply with Pydantic v2 expectations and avoid the "return self" warning. Add regression tests for single/list resources with included payloads, and update resource id resolution to access model_fields from the model class to remove v2.11 deprecation warnings.
Add a quickstart, API reference, Pydantic v2 notes, and practical snippets for resource configuration and included relationships to make the PyPI-facing docs easier to navigate.
Introduce mkdocs.yml with Material theme, mkdocstrings-based API pages under docs/mkdocs, optional [docs] extras, and a docs-build script. Switch Read the Docs to MkDocs with pip install .[docs], run MkDocs in CI, and link the published docs from the README.
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.
Summary
Adds a MkDocs Material documentation site (similar in toolchain to FastAPI/Pydantic), wires Read the Docs to build from
mkdocs.yml, and runs a strict MkDocs build in CI so broken docs fail PR checks.Motivation
What’s included
mkdocs.yml— Material theme, search, strict mode,docs_dir: docs/mkdocs.docs/mkdocs/— Home, Getting started, API reference (mkdocstrings), FastAPI, Contributing.[project.optional-dependencies] docs—mkdocs-material,mkdocstrings[python].docs-build—uv sync --extra docs+mkdocs build --strict..readthedocs.yaml— switched from Sphinx to MkDocs, installs withpip install .[docs]..github/workflows/python-app.yml—uv sync --extra docs+uv run ./docs-buildafter typecheck.README.md— prominent docs URL + how to runmkdocs serve/./docs-buildlocally.Notes for maintainers
.readthedocs.yaml(they were tied to Sphinx). HTML-only is typical for MkDocs; PDF can be revisited separately if desired.docs/conf.py/ Sphinx scaffold remains in the repo for reference; the canonical published build is MkDocs per Contributing.Test plan
uv sync --extra docsuv run ./docs-build(strict)pytest(existing suite)