-
Notifications
You must be signed in to change notification settings - Fork 493
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
Fixed guides scrolling horizontal layout bug #7221
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm getting this error when I try to build the docs (using Sphinx 1.5.6):
Warning, treated as error:
/Users/pdurbin/github/iqss/guides.dataverse.org/doc/sphinx-guides/source/admin/mail-groups.rst:65: WARNING: undefined label: domaingroup1.json (if the link has no caption the label must precede a section header)
I think it has something to do with this line because if I delete it, the error goes away:
Editing a group is done by replacing it. Grab your group definition like the :ref:`above example <domainGroup1.json>`,
Removed ref to removed caption. Didn't notice that warning when building locally for whatever reason. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking good as of e26d4ea
@poikilotherm I guess we shouldn't use captions.
@pdurbin @poikilotherm, didn't dig into how we can fix the use of captions. Just saw that captions caused bad horizontal scrolling issues, so I moved that context into the main content text. There is another issue related the Sphinx version update #7233 that might magically resolve this simply by using the latest and greatest version of Sphinx... OR... it might require us to use not only the latest version of Sphinx to build the guides BUT also an updated version of the theme template files to resolve this layout issue. |
@mheppler sure. Seems like a good fix. At first I was skeptical about it closing #3577 since pages are mentioned in there (Shib, Two Ravens) that you didn't touch. I have no idea why those pages are ok now. I guess we just need to keep avoiding horizontal scroll for now. And yeah, like you said, we're way behind on Sphinx so maybe an upgrade will help. |
What this PR does / why we need it:
Removes
:caption::
option from code-block in two pages to fix a horizontal scrolling over sidenav layout bug. Moved caption to context text so users can still reference it.Which issue(s) this PR closes:
Closes #3577 Documentation: When content is wide enough to require horizontal scroll, content scrolls but left nav outline does not.
Special notes for your reviewer:
Suggestions on how to test this:
Does this PR introduce a user interface change? If mockups are available, please link/include them here:
Is there a release notes update needed for this change?:
Additional documentation: