Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Use mkdocstring syntax for code-api generation #5892

Merged
merged 2 commits into from
Oct 22, 2024
Merged

Use mkdocstring syntax for code-api generation #5892

merged 2 commits into from
Oct 22, 2024

Commits on Oct 15, 2024

  1. Fix code-api generated docs generation directives 

    The reference doc pages were using sphinx code-gen directives.
This replaces those with mkdocstrings directives and tries to apply
corresponding configurations where applicable.

Closes: pulp#5834
    @pedro-psb
    pedro-psb committed Oct 15, 2024
    Configuration menu
    Copy the full SHA
    5c97b3c View commit details
    Browse the repository at this point in the history

  2. Add __all__ attribute to modules 

    The reason for this is because mkdocstrings requires this declaration
to display imported members:

https://mkdocstrings.github.io/python/usage/configuration/general/?h=import#preload_modules

When we are using `__all__`, we could use star imports to avoid so much name
duplication.

Fixup: remove F401 when using __all__ and remove unecessary options
    @pedro-psb
    pedro-psb committed Oct 15, 2024
    Configuration menu
    Copy the full SHA
    a5aceb5 View commit details
    Browse the repository at this point in the history