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

Plugin API docs are not properly rendered #5834

Closed
dkliban opened this issue Sep 24, 2024 · 2 comments
Closed

Plugin API docs are not properly rendered #5834

dkliban opened this issue Sep 24, 2024 · 2 comments
Labels
Documentation Issue

Comments

@dkliban
Copy link
Member

dkliban commented Sep 24, 2024

Went to look at this page and realized it wasn't rendering the content properly

https://pulpproject.org/pulpcore/docs/dev/reference/code-api/plugins-api/util/
@pedro-psb
Copy link
Member

That's the right place. We use the mkdocstrings plugin for that, so it should follow it's syntax:
https://mkdocstrings.github.io/usage/

@clintonsteiner
Copy link

Appears to be fixed now?

pedro-psb added a commit to pedro-psb/pulpcore that referenced this issue Oct 9, 2024
@pedro-psb
Fix code-api generated docs generation directives
c0aaec0 
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 added a commit to pedro-psb/pulpcore that referenced this issue Oct 9, 2024
@pedro-psb
Fix code-api generated docs generation directives
06248ac 
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 added a commit to pedro-psb/pulpcore that referenced this issue Oct 15, 2024
@pedro-psb
Fix code-api generated docs generation directives
5c97b3c 
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation Issue
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@dkliban @pedro-psb @clintonsteiner