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.

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

Don't use experimental readthedocs build.commands config #4606

Merged
merged 6 commits into from
Dec 18, 2023

Conversation

cosmicBboy
Copy link
Contributor

@cosmicBboy cosmicBboy commented Dec 15, 2023

This PR changes the monodocs readthedocs config so that it uses the customizeable readthedocs build steps instead of the experimental build.commands config key. This is because there are some issues with correctly rendering the readthedocs flyout menu: readthedocs/readthedocs.org#10955

Preview: https://flyte-next.readthedocs.io/en/monodocs-readthedocs-config/

image

vs.

https://flyte-next.readthedocs.io/en/latest/ (readthedocs inserted dropdown is missing)
image

@dosubot dosubot bot added size:S This PR changes 10-29 lines, ignoring generated files. documentation Improvements or additions to documentation labels Dec 15, 2023
Copy link

codecov bot commented Dec 15, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (398e5cb) 59.03% compared to head (17e44b7) 59.03%.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #4606   +/-   ##
=======================================
  Coverage   59.03%   59.03%           
=======================================
  Files         622      622           
  Lines       52682    52682           
=======================================
+ Hits        31102    31103    +1     
+ Misses      19098    19097    -1     
  Partials     2482     2482           
Flag Coverage Δ
unittests 59.03% <ø> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@cosmicBboy cosmicBboy changed the title dont use experimental readthedocs build.commands config [wip] dont use experimental readthedocs build.commands config Dec 15, 2023
Signed-off-by: Niels Bantilan <[email protected]>
Signed-off-by: Niels Bantilan <[email protected]>
Signed-off-by: Niels Bantilan <[email protected]>
Signed-off-by: Niels Bantilan <[email protected]>
@cosmicBboy
Copy link
Contributor Author

@thomasjpfan I opted for your solution to this, because readthedocs adds additional configuration to the user-supplied conf.py file, and not doing this will cause issues such as not showing the readthedocs version dropdown.

@cosmicBboy cosmicBboy changed the title [wip] dont use experimental readthedocs build.commands config Don't use experimental readthedocs build.commands config Dec 18, 2023
@cosmicBboy cosmicBboy closed this Dec 18, 2023
@cosmicBboy cosmicBboy reopened this Dec 18, 2023
@cosmicBboy cosmicBboy merged commit 14915dc into master Dec 18, 2023
80 of 84 checks passed
@cosmicBboy cosmicBboy deleted the monodocs-readthedocs-config branch December 18, 2023 16:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation size:S This PR changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants