Migrate to Readthedocs and Sphinx #890
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
git push
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #890 +/- ##
==========================================
+ Coverage 52.29% 54.23% +1.93%
==========================================
Files 20 20
Lines 3991 4326 +335
==========================================
+ Hits 2087 2346 +259
- Misses 1904 1980 +76 ☔ View full report in Codecov by Sentry. |
|
You already know I find this absolutely incredible, Mark, and we discussed reviewing these things after merging. So on my end, we're good to go! |
|
@Joao-Dionisio thank you! I am extremely happy with the outcome of this. (you have to actually approve the MR which I always forget to do) |
Joao-Dionisio
approved these changes
Sep 7, 2024
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 change moves our documentation from GitHub to Readthedocs.
I've added a basic structure / install guides / introduction to most plug-ins / motivation for using SCIP / FAQ / API reference manual.
I've also added a few new wrapper functions. These were needed when implementing the new examples in the documentation that are now duplicated as tests.
After this gets merged we'd need to do the following: