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.

Sign up for GitHub

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

Jump to bottom

Adjust documentation webpage layout to be compatible with RTD addons #15270

Open
r0qs opened this issue Jul 18, 2024 · 2 comments
Open

Adjust documentation webpage layout to be compatible with RTD addons #15270

r0qs opened this issue Jul 18, 2024 · 2 comments
Labels
documentation 📖 must have eventually Something we consider essential but not enough to prevent us from releasing Solidity 1.0 without it.

Comments

@r0qs
Copy link
Member

r0qs commented Jul 18, 2024

Read The Docs will be enabling addons by default on October 7, 2024 and this will break the docs layout. See images below and also this link with the layout changes introduced with the addons: https://about.readthedocs.com/blog/2024/04/enable-beta-addons/

Relevant changes related to the documentation web page layout:

Visual changes

Even if the build has completed successfully, there may be some visual changes.
Version and pull request notifications were completely re-designed and the flyout menu has been moved to a floating position in
the bottom right, for example.

Depending on your project's configuration, the documentation tool and the theme you are using, you will notice these differences.
We plan to release a new version of our theme to keep the flyout menu at the bottom left integrated with the navbar soon,
and we are talking to other theme authors to communicate these changes and work with them towards a better integration.
Expect news around this visual changes in the following months.

In our case, the main doc page layout, the flyout panel and the search bar may need to be adjusted.
2024-07-18-168633_4176x1504_scrot
2024-07-18-168638_4176x1504_scrot

Maybe @wackerow could take a look on that? Maybe it is just a matter to adjust the sphinx_rtd_theme?
@wackerow
Copy link
Member

Thanks for surfacing @r0qs... can try to find some bandwidth to take a look at this.

@r0qs r0qs added should have We like the idea but it’s not important enough to be a part of the roadmap. must have eventually Something we consider essential but not enough to prevent us from releasing Solidity 1.0 without it. and removed should have We like the idea but it’s not important enough to be a part of the roadmap. labels Jul 18, 2024
@r0qs
Copy link
Member Author

r0qs commented Jul 18, 2024

I also reviewed the possible changes needed for our Sphinx configuration since RTD will no longer be handling these themselves. It appears we don't need to make any changes there. After enabling the addons on the RTD dashboard, only the layout was affected, as far as I could see.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation 📖 must have eventually Something we consider essential but not enough to prevent us from releasing Solidity 1.0 without it.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@r0qs @wackerow