-
Notifications
You must be signed in to change notification settings - Fork 6k
Docs strings for python aren't parsed properly by sphinx #9630
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.
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
Open
oz123 opened this issue
Aug 8, 2019
· 0 comments
· Fixed by OpenAPITools/openapi-generator#6391 · May be fixed by #10259 or Ark-kun/openapi-generator#1
Open
Docs strings for python aren't parsed properly by sphinx #9630
oz123 opened this issue
Aug 8, 2019
· 0 comments
· Fixed by OpenAPITools/openapi-generator#6391 · May be fixed by #10259 or Ark-kun/openapi-generator#1
Comments
Ark-kun
added a commit
to Ark-kun/swagger-codegen
that referenced
this issue
May 19, 2020
4 tasks
Ark-kun
added a commit
to Ark-kun/swagger-codegen
that referenced
this issue
May 22, 2020
Ark-kun
added a commit
to Ark-kun/openapi-generator
that referenced
this issue
May 22, 2020
This was referenced May 22, 2020
spacether
pushed a commit
to OpenAPITools/openapi-generator
that referenced
this issue
Jun 4, 2020
* [Python] Fixed docstrings Fixes swagger-api/swagger-codegen#9630 * Updated generated files * Fixed python-experimental * Updated generated files * Fully fixed the format of the docstrings * Updated generated files * Updated generated files in openapi3
therve
pushed a commit
to DataDog/datadog-api-client-python
that referenced
this issue
Mar 23, 2021
* [Python] Fixed docstrings Fixes swagger-api/swagger-codegen#9630 * Updated generated files * Fixed python-experimental * Updated generated files * Fully fixed the format of the docstrings * Updated generated files * Updated generated files in openapi3
jirikuncar
pushed a commit
to DataDog/datadog-api-client-python
that referenced
this issue
Sep 8, 2021
* [Python] Fixed docstrings Fixes swagger-api/swagger-codegen#9630 * Updated generated files * Fixed python-experimental * Updated generated files * Fully fixed the format of the docstrings * Updated generated files * Updated generated files in openapi3
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Description
Sphinx is defacto the documentation systems for Python (although it can be used and is used also by projects in other languages - a notable example is the linux kernel). Hence, when working with code for Python which is generated by swagger I'd expect the doc strings to render properly with sphinx.
Currently, the doc strings aren't rendered properly. This is how it should be rendered:
This is how it is actually rendered:
Suggest a fix/enhancement
To render the documentation properly, the output format should be slightly modified. Here is a diff of how the output should be modified to:
Swagger-codegen version
See here
https://github.com/kubernetes-client/python/blob/master/scripts/update-client.sh
Swagger declaration file content or url
https://github.com/kubernetes-client/python/blob/master/scripts/swagger.json
The text was updated successfully, but these errors were encountered: