From efe721340643fc8dc7ee58347078cf1c6432cb7d Mon Sep 17 00:00:00 2001 From: Colin Haywood Date: Thu, 5 Nov 2026 09:45:34 +1300 Subject: [PATCH] docs: fix the Sphinx warnings that fail the docs build --- datamasque/client/models/project.py | 2 +- docs/conf.py | 7 ++++--- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/datamasque/client/models/project.py b/datamasque/client/models/project.py index bbe4eae..79c8c72 100644 --- a/datamasque/client/models/project.py +++ b/datamasque/client/models/project.py @@ -79,7 +79,7 @@ class ProjectCreateRequest(BaseModel): """ Request body for `POST /api/projects/`. - A name must not be ".", start with "DataMasque_", or contain "/", ".." or a control character, + A name must not be `.`, start with `DataMasque_`, or contain `/`, `..` or a control character, and must differ, ignoring case, from the name of every other active project. The server trims leading and trailing whitespace from `name` and `description`. """ diff --git a/docs/conf.py b/docs/conf.py index 3ef2bd2..db0aa2b 100755 --- a/docs/conf.py +++ b/docs/conf.py @@ -47,10 +47,11 @@ # Python identifiers that DO resolve still get cross-linked. suppress_warnings = ["ref.any"] -# Exclude pydantic's `model_config` attribute from autodoc output — -# it's plumbing, not public API, and clutters every model's docs page. +# Exclude pydantic's `model_config` attribute and the `drop_namespace` validator from autodoc output. +# Both are plumbing, not public API, and `model_config` would clutter every model's docs page. +# Documenting `drop_namespace` would also fail the -W build: its `type` annotation matches every `.type` attribute. autodoc_default_options = { - "exclude-members": "model_config", + "exclude-members": "model_config,drop_namespace", } # Add any paths that contain templates here, relative to this directory.