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

[docs/python] Complex types are rendered poorly by Sphinx #1090

Closed
ebezzi opened this issue Mar 10, 2023 · 5 comments
Closed

[docs/python] Complex types are rendered poorly by Sphinx #1090

ebezzi opened this issue Mar 10, 2023 · 5 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request python-api

Comments

@ebezzi
Copy link
Member

ebezzi commented Mar 10, 2023

Some types (especially union types) are rendered by Sphinx in a confusing way:

Image

Find out if they can be simplified. Ideally, the type in question should not be expanded but instead link to its definition.

@johnkerl johnkerl added documentation Improvements or additions to documentation python-api enhancement New feature or request labels Mar 10, 2023
@johnkerl johnkerl self-assigned this Mar 13, 2023
@thetorpedodog
Copy link
Contributor

this is unfortunate and rather unhelpful, but extremely funny

@johnkerl
Copy link
Member

johnkerl commented Apr 3, 2023

Support is not live yet:

It remains to be seen whether this will land in Sphinx before or after we move from Sphinx to Quarto (#1055).

@johnkerl
Copy link
Member

johnkerl commented Apr 3, 2023

We can do no more in this sprint, but I'm leaving this issue open until (a) the above Sphinx feature lands, or (b) this issue is obviated by #1055.

@johnkerl johnkerl changed the title [docs] [python] Complex types are rendered poorly by Sphinx [docs/python] Complex types are rendered poorly by Sphinx Apr 3, 2023
@johnkerl
Copy link
Member

To be resolved by #1055

@johnkerl
Copy link
Member

johnkerl commented May 8, 2023

Obviated by #1055

@johnkerl johnkerl closed this as completed May 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request python-api
Projects
None yet
Development

No branches or pull requests

3 participants