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

HTML repr in the online docs #3893

Open
shoyer opened this issue Mar 26, 2020 · 3 comments
Open

HTML repr in the online docs #3893

shoyer opened this issue Mar 26, 2020 · 3 comments

Comments

@shoyer
Copy link
Member

shoyer commented Mar 26, 2020

I noticed two minor issues in our online docs, now that we've switched to the hip new HTML repr by default.

  1. Most doc pages still show text, not HTML. I suspect this is a limitation of the IPython sphinx derictive we use for our snippets. We might be able to fix that by switching to jupyter-sphinx?

  2. The "attributes" part of the HTML repr in our notebook examples looks a little funny, with strange blue formatting around each attribute name. It looks like part of the outer style of our docs is leaking into the HTML repr:
    image

@stale
Copy link

stale bot commented May 2, 2022

In order to maintain a list of currently relevant issues, we mark issues as stale after a period of inactivity

If this issue remains relevant, please comment here or remove the stale label; otherwise it will be marked as closed automatically

@stale stale bot added the stale label May 2, 2022
@dcherian
Copy link
Contributor

dcherian commented May 2, 2022

Most doc pages still show text, not HTML. I suspect this is a limitation of the IPython sphinx derictive we use for our snippets. We might be able to fix that by switching to jupyter-sphinx?

We can also switch from RST to MyST. It works quite well

I think the second point is fixed now.

@stale stale bot removed the stale label May 2, 2022
@max-sixty
Copy link
Collaborator

Is the first point covered by #6620, albeit a more recent issue?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants