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.

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

Improve page readability in python client documentation #415

Open
Geogouz opened this issue Dec 8, 2024 · 1 comment
Open

Improve page readability in python client documentation #415

Geogouz opened this issue Dec 8, 2024 · 1 comment
Assignees
Labels
enhancement New feature or request

Comments

@Geogouz
Copy link
Contributor

Geogouz commented Dec 8, 2024

Currently, when extended text content is added to table descriptions in the Python client documentation, the content is squeezed into narrow columns, making it a bit difficult to read.

I would propose couple changes to the mkdocs.yml configuration:

  • Switch to docstring_section_style: "spacy" (this style might improve table formatting by allocating more space to the description column).
  • Enable the following options for better page aesthetics:
    • separate_signature: true (this separates the method signature from the rest of the content, making it clearer.)
    • show_category_heading: true (this introduces category headings, adding some better structure.)

To illustrate the difference, I provide these two examples:

Current view
Suggested view

@voetberg
Copy link
Contributor

voetberg commented Dec 9, 2024

Sounds like a good idea!

Question: What do the little 'add to clipboard' buttons next to the function definitions actually copy?

@voetberg voetberg added the enhancement New feature or request label Dec 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants