-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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
Using caption with different toc sections instead of JS/CSS hack. #1025
Conversation
|
Previous comments that were addressed in later changes: This fits within the Sphinx construct and would allow our docs to be built on readthedocs.org. Unfortunately, this doesn't quite agree with our CSS (we need some left-hand padding): I got this inspiration / technique from (source): As a test to see if our docs would build in the readthedocs theme, I swapped out |
c062561
to
65e7b2c
Compare
65e7b2c
to
0a4fde6
Compare
Mine is |
This fits within the Sphinx construct and would allow our docs to be built on readthedocs.org.
0a4fde6
to
865a78a
Compare
@tseaver Added you as a maintainer. Are you reviewing this? |
@tseaver Any issues with these changes? |
Sorry, I thought from the botched rendering in the last example it wasn't ready to go. LGTM. |
Using caption with different toc sections instead of JS/CSS hack.
@tseaver Do you know much about RTD? It's using the old Sphinx theme for some reason (though not locally via |
I think it might be my use of if ON_READ_THE_DOCS or LOCAL_READ_THE_DOCS:
templates_path = []
else:
templates_path = ['_templates'] i.e. I think RTD uses |
Scratch that, it was the use of |
Using caption with different toc sections instead of JS/CSS hack.
This fits within the Sphinx construct and would allow our docs to be built on readthedocs.org.
Building with
tox -e docs
we get:Building with
LOCAL_RTD=True tox -e docs
we get:AFAICT, by using
:titlesonly:
and some other rules we can get rid of the expandable sections (or just not use h1, or change maxdepth).