Use mkdocstring syntax for code-api generation #5892
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pedro-psb
force-pushed
the
docs/use-mkdocstring-syntax-for-code
branch
from
1fc671f
to
48ec098
Compare
mdellweg
reviewed
Oct 10, 2024
pulpcore/plugin/tasking.py
Outdated
| @@ -13,3 +13,18 @@ | |||
| reclaim_space, | |||
| ) | |||
| from pulpcore.app.tasks.repository import add_and_remove # noqa: F401 | |||
There was a problem hiding this comment.
If we do the __all__ thing. we don't need the noqa: F401 anymore.
| ``` | ||
| ::: pulpcore.plugin.stages.ContentSaver | ||
| options: | ||
| filters: ["!_pre_save", "!_post_save"] |
There was a problem hiding this comment.
Should we add the filter "!_*" to the mkdoc config?
| @@ -9,83 +7,44 @@ to make writing sync code easier. There are several parts to the API: | |||
| 2. The builtin Stages including `artifact-stages` and `content-stages`. | |||
| 3. The `stages-api`, which allows you to build custom stages and pipelines. | |||
|
|
|||
|
|
|||
|
|
|||
| ## DeclarativeVersion | |||
There was a problem hiding this comment.
This whole file would be much shorter if we just called this section Reference and did ::: pulpcore.plugin.stages.
There was a problem hiding this comment.
Yeah, but IHO these groupings are helpful.
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
force-pushed
the
docs/use-mkdocstring-syntax-for-code
branch
from
84b5a93
to
a4a7850
Compare
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
force-pushed
the
docs/use-mkdocstring-syntax-for-code
branch
from
a4a7850
to
a5aceb5
Compare
mdellweg
approved these changes
Oct 22, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The reference doc pages were using sphinx code-gen directives. This replaces those with mkdocstrings directives and tries to apply corresponding configurations where applicable.
To verify it works, you can serve this PR locally and skim through the subtree of:
pulpcore/docs/dev/reference/code-api/platform-api/pulpcore/docs/dev/reference/code-api/plugins-api/As noted in the second commit, the introduction of
__all__is because mkdocstrings requires this declarationto display imported members.