cylc / cylc-uiserver

A Jupyter Server extension that serves the cylc-ui web application for monitoring and controlling Cylc workflows.
https://cylc.org
GNU General Public License v3.0
15 stars 18 forks source link

Fix sphinx autodoc warning #560

Closed MetRonnie closed 7 months ago

MetRonnie commented 7 months ago

Workaround https://github.com/sphinx-doc/sphinx/issues/10151#issuecomment-1540802189

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