Skip to content
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.

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

Fix sphinx autodoc warning #560

Merged
merged 2 commits into from
Feb 26, 2024
Merged

Fix sphinx autodoc warning #560

merged 2 commits into from
Feb 26, 2024

Conversation

MetRonnie
Copy link
Member

@MetRonnie MetRonnie commented Feb 26, 2024

Workaround sphinx-doc/sphinx#10151 (comment)

CylcAuthorizer inherits from trailets.Configurable. The problem is:

In their code, they do import typing as t and they call t.Any, t.Dict, etc...

then when I compile my docs I see warnings as

WARNING: py:class reference target not found: t.Any

If there was some way of disabling the autodoc'ing of (just) CylcAuthorizer's params in cylc-doc I would have gone for that, but I couldn't find any way.

Check List

  • I have read CONTRIBUTING.md and added my name as a Code Contributor.
  • Contains logically grouped changes (else tidy your branch by rebase).
  • Does not contain off-topic changes (use other PRs for other changes).
  • No dependency changes
  • Tests are not needed
  • No CHANGES.md entry needed
  • Xtriggers: Doc Fixes cylc-doc#686

@MetRonnie MetRonnie added this to the 1.5.0 milestone Feb 26, 2024
@MetRonnie MetRonnie self-assigned this Feb 26, 2024
cylc/uiserver/authorise.py Show resolved Hide resolved
Co-authored-by: Oliver Sanders <oliver.sanders@metoffice.gov.uk>
@MetRonnie MetRonnie merged commit 2141402 into cylc:master Feb 26, 2024
3 checks passed
@MetRonnie MetRonnie deleted the sphinx branch February 26, 2024 14:26
@MetRonnie MetRonnie mentioned this pull request Feb 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants