Skip to content

griffe is reporting issues with API repositories #484

@llucax

Description

@llucax

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: false

Metadata

Metadata

Assignees

No one assigned

    Labels

    part:mkdocsAffects the configuration of mkdocspart:only-apiAffects the configuration of a api repopart:templateAffects the cookiecutter template filespart:toolingAffects the development tooling (CI, deployment, dependency management, etc.)type:bugSomething isn't working

    Type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions