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
Addons: integrate with new beta addons flyout #1526
base: master
Are you sure you want to change the base?
Conversation
Initial experimentation to use the `CustomEvent` triggered by the addons called `readthedocsdataready` event (from readthedocs/addons#64) to build the Read the Docs flyout being integrated into the theme keeping the original look & feel. * Related: readthedocs/addons#64 * Closes #1523
This is because we are not executing the Read the Docs magic that modifies the `conf.py` file on the fly :/
Noted on a call today, we should start trying out these changes for some of our own projects to start. This would serve as a working example for other authors, and gives us something to test against. |
This can be disabled per-project by using the settings UI from the dashboard.
Use the current pattern to translate string generated for the flyout.
Installs a version of our theme from a pull request that has support for the Addons integration using the `CustomEvent`. Related: readthedocs/sphinx_rtd_theme#1526 Requires: #11205
I marking this PR ready for review so I can get a new review round here. I'm happy with the current pattern and I think we should start testing it out in our own docs first by installing it from this branch: readthedocs/readthedocs.org#11279 |
Installs a version of our theme from a pull request that has support for the Addons integration using the `CustomEvent`. Related: readthedocs/sphinx_rtd_theme#1526 Requires: #11205
I tested this in https://docs--11279.org.readthedocs.build/en/11279/ and I found we need to hide the sections if we don't have content on them: Also, the "Search" input is not shown. The footer also is not shown. |
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.
Not sure how complete this is, I didn't test this locally. But this seems on the right path, just some tweaking needed to the template.
Co-authored-by: Anthony <aj@ohess.org>
It's great knowing that we are going in the right direction. The PR is not finished or ready to merge yet, but I wanted to have a review at this stage to know if we are aligned here and it seems we are 👍🏼 |
With the latest changes, it looks great to me! I think we are ready to merge readthedocs/readthedocs.org#11279 so we can start testing it out in our documentation. |
Yeah lets merge the docs PR 👍 This seems close enough to start testing |
…11279) * Docs: use the `sphinx-rtd-theme` with support for addons integration Installs a version of our theme from a pull request that has support for the Addons integration using the `CustomEvent`. Related: readthedocs/sphinx_rtd_theme#1526 Requires: #11205 * Disable fail on warning temporary * Delete doc-diff since it's included in addons now
Initial experimentation to use the
CustomEvent
triggered by the addons calledreadthedocs-addons-data-ready
event (from readthedocs/addons#64) to build the Read the Docs flyout being integrated into the theme keeping the original look & feel.How to test it
READTHEDOCS
variablehumitos/custom-event
branchlocalhost
here)Example
Note
I added these lines in
versions.html
and also hardcoded the URL to hit in the
readthedocs-config.js
addons file asand used Firefox CORS Addon to allow CORS with the development instance
<meta>
to define supported API version and triggerCustomEvent
addons#64