Skip to content

docs: fix the Sphinx warnings that fail the docs build #73

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
carlosfunk merged 1 commit into from
Nov 12, 2026
Merged

docs: fix the Sphinx warnings that fail the docs build #73

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion datamasque/client/models/project.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
"""
Expand Down
7 changes: 4 additions & 3 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading