-
Notifications
You must be signed in to change notification settings - Fork 8
Open
Labels
part:mkdocsAffects the configuration of mkdocsAffects the configuration of mkdocspart:only-apiAffects the configuration of a api repoAffects the configuration of a api repopart:templateAffects the cookiecutter template filesAffects the cookiecutter template filespart:toolingAffects the development tooling (CI, deployment, dependency management, etc.)Affects the development tooling (CI, deployment, dependency management, etc.)type:bugSomething isn't workingSomething isn't working
Milestone
Description
What happened?
When running mkdocs in API repos, griffe is complaining about generated files.
For example:
WARNING - griffe: py/frequenz/api/hostmanagement/v1/hostmanagement_pb2_grpc.py:108: No type or annotation for
parameter 'channel'Since we run mkdocs in strict mode, this makes docs generation fails.
What did you expect instead?
No warnings.
Affected version(s)
No response
Affected part(s)
Affects the configuration of a api repo (part:api-only), Tools to configure mkdocs (part:mkdocs)
Extra information
Ideally we should investigate and see if this can be avoided in a clean way.
If not, we can use the following workaround: disable warnings about missing types in mkdocs.yml:
plugins:
- mkdocstrings:
handlers:
python:
options:
docstring_options:
warn_missing_types: falseMetadata
Metadata
Assignees
Labels
part:mkdocsAffects the configuration of mkdocsAffects the configuration of mkdocspart:only-apiAffects the configuration of a api repoAffects the configuration of a api repopart:templateAffects the cookiecutter template filesAffects the cookiecutter template filespart:toolingAffects the development tooling (CI, deployment, dependency management, etc.)Affects the development tooling (CI, deployment, dependency management, etc.)type:bugSomething isn't workingSomething isn't working