-
Notifications
You must be signed in to change notification settings - Fork 8
griffe is reporting issues with API repositories #484
Copy link
Copy link
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
Metadata
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
What happened?
When running
mkdocsin API repos,griffeis complaining about generated files.For example:
Since we run
mkdocsinstrictmode, 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: