extremely basic rtd impl #102
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
…ng sphinx documentation strings
Codecov Report
@@ Coverage Diff @@
## master #102 +/- ##
==========================================
- Coverage 13.40% 13.02% -0.38%
==========================================
Files 40 40
Lines 873 898 +25
Branches 14 14
==========================================
Hits 117 117
- Misses 756 781 +25
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
ayyaruq
reviewed
Nov 6, 2022
There was a problem hiding this comment.
A few comments, mostly just observations and some nits before I gave up on doing that before the PR is out of draft. Structurally it seems fine, docs could use some editing for consistency with punctuation/capitalisation but I can do a full pass later with suggestions you can just hit or dismiss.
One Q tho, is Make the best idea here? I know we spoke about Taskfiles before and Make isn't super approachable beyond basics.
ayyaruq
approved these changes
Dec 5, 2022
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.
Purpose
This is the start of a transition from pydoc to sphinx for readthedocs (so we're more in line with what the general community does for python projects)
New Features
s/pydoc/sphinx/Bug Fixes
No bug fixes, but we're severely lacking on documentation now. Also the workflows will need to change.
Before/After
s/pydoc/sphinx/Additional Context
Restructured text is... far from my favorite.