Include examples in readthedocs (port) #2392
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-Authored-By: Jan Kwakkel <[email protected]>
Rename the streamlit app to app.py and remove the unused files. Co-Authored-By: Jan Kwakkel <[email protected]>
This comment was marked as off-topic.
This comment was marked as off-topic.
|
this breaks on RTD because some files have not been renamed properly (my hunch). |
|
Thanks, indeed forgot to rename the README.md files. It now passes. |
|
This fixes the build. I'll review later this morning. |
|
Looking at the diff, it seems good to go. This one has 2 more files that are changed (i.e.., removed). Not sure how this PR is any different from the original once its squashed and merged. |
quaquel
approved these changes
Oct 21, 2024
|
Thanks!
It prevents the 3 duplicate files from being included. Maybe that would have resolved itself when squashing, or maybe not. |
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a manual port of #2382 because some weird shit happened there after merging the main branch a few times into it. This is a clean version based of that PR.
This updates conf.py to create markdown files for including the examples in the documentation. It also cleans up some warning on RTD, which happened while debugging the code. In this process, this also fixes #2360.
It currently only covers the basic examples because the advanced examples are not fully cleaned yet.