CLI documentation page generation #342
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
bittremieux
reviewed
Jul 2, 2024
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## dev #342 +/- ##
==========================================
+ Coverage 89.34% 89.88% +0.53%
==========================================
Files 12 12
Lines 929 929
==========================================
+ Hits 830 835 +5
+ Misses 99 94 -5 ☔ View full report in Codecov by Sentry. |
bittremieux
requested changes
Jul 9, 2024
docs/conf.py
Outdated
| @@ -57,9 +58,13 @@ | |||
| # Add any paths that contain custom static files (such as style sheets) here, | |||
| # relative to this directory. They are copied after the builtin static files, | |||
| # so a file named "default.css" will overwrite the builtin "default.css". | |||
| html_static_path = ["_static"] | |||
| # html_static_path = ["_static"] | |||
There was a problem hiding this comment.
question: Does this need to be commented?
There was a problem hiding this comment.
AFIK this was originally left as a commented out piece of code in the conf.py template, but I'll go ahead and remove it.
There was a problem hiding this comment.
It's currently not commented on main, so unless the change is required, I think we can leave it as-is. So rather than remove it, put it back in there and not commented.
bittremieux
approved these changes
Jul 9, 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.
I implemented automatic documentation generation for the casanovo CLI using the sphinx-click package. This does introduce a new dependency on the sphinx-click python package in order to build the documentation.