Skip to content

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

Merged
carlosfunk merged 1 commit into
epic/DM-4993-reland-projectsfrom
fix-docs-build
Nov 12, 2026
Merged

carlosfunk merged 1 commit into
epic/DM-4993-reland-projectsfrom
fix-docs-build

Conversation

@cph-datamasque

Copy link
Copy Markdown
Collaborator

Fixes the two Sphinx warnings that failed the Docs (sphinx) job when the projects epic merged into main.

  • Puts the literals in the ProjectCreateRequest docstring in single backticks, because the trailing underscore in "DataMasque_" is a hyperlink reference in reST.
  • Leaves the internal drop_namespace helper out of the docs, because Sphinx matches its type annotation against every documented .type attribute.

CI does not run on this PR because its base is not main. sphinx-build -W --keep-going passes locally on this branch, and the docs job runs when #72 is retargeted to main.

@cph-datamasque cph-datamasque self-assigned this Nov 4, 2026
@elliotsimpson-dm
elliotsimpson-dm force-pushed the epic/DM-4993-reland-projects branch 2 times, most recently from f7d1d06 to d122bf5 Compare November 5, 2026 19:23
@carlosfunk
carlosfunk requested review from carlosfunk and removed request for elliotsimpson-dm November 12, 2026 02:40
@carlosfunk
carlosfunk added this pull request to stack #82 November 12, 2026 02:44
@carlosfunk
carlosfunk removed this pull request from stack #82 November 12, 2026 02:46
@carlosfunk
carlosfunk merged commit 92060e8 into epic/DM-4993-reland-projects Nov 12, 2026
9 checks passed
@carlosfunk
carlosfunk deleted the fix-docs-build branch November 12, 2026 02:46
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.

2 participants