search

pulp / pulp-docs

Python Package to help aggregating Pulp's multirepo ecosystem into a unified doc.
https://pedro-psb.github.io/pulp-docs/
2 stars 4 forks source link

Can't handle having `pulpcore` module outside pulpcore (mkdocstrings) #28

Closed pedro-psb closed 4 months ago

pedro-psb commented 5 months ago

The pulp-cli has a pulpcore/cli/common/generic.py module structure but it can't reference it like this in markdown:

::: pulpcore.cli.common.generic

Actually we are using a hardcoded workaround for this (in mkdocs_macros:_place_doc_files) , but this should be generalized.

TODO: provide a better description of this issue later.

pedro-psb commented 4 months ago

This was fixed in mkdocstring-python 1.9.1 release: https://github.com/mkdocstrings/python/releases/tag/1.9.1