Skip to content

Fix formatting in the custom derivatives notebook #3876

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

Merged
merged 1 commit into from
Jul 28, 2020

Conversation

shoyer
Copy link
Collaborator

@shoyer shoyer commented Jul 28, 2020

Sphinx is apparently quite picky about consistent use of headers: you can't
skip a header level. We were getting warnings like "WARNING: Title level
inconsistent" in the docs build, and sub-headers weren't showing up on this
page after the first section.

Sphinx is apparently quite picky about consistent use of headers: you can't
skip a header level. We were getting warnings like "WARNING: Title level
inconsistent" in the docs build, and sub-headers weren't showing up on this
page after the first section.
@google-cla google-cla bot added the cla: yes label Jul 28, 2020
Copy link
Collaborator

@mattjj mattjj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hrm, I remember liking how this rendered in Colab, but not as much in Sphinx. Anyway if you think this is better then that's good enough for me!

@shoyer
Copy link
Collaborator Author

shoyer commented Jul 28, 2020

The problem is that sphinx defaults to hiding headers at the "wrong" indentation. So the online docs (which I suspect is how most users read them) don't have any subheaders. This makes them harder to read and harder to link to.

e.g.,

Before:
image

After -- notice the new "Numerical stability" header:
image

@shoyer shoyer merged commit dd7ab39 into jax-ml:master Jul 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants