Clean Sphinx docs for release #115
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #115 +/- ##
==========================================
+ Coverage 66.60% 66.62% +0.02%
==========================================
Files 14 14
Lines 1560 1561 +1
==========================================
+ Hits 1039 1040 +1
Misses 521 521 ☔ View full report in Codecov by Sentry. |
However, the version in pyproject.toml was 1.0.2. Altered __init__ so that the version need now only be specified in pyproject.toml and set it to the upcoming version. When running tests via tox nocoverage, I see v1.1.0 being installed now. In those virtual environments, pip list shows v1.1.0. If I import Taweret, Taweret.__version__ shows v1.1.0. The rendered sphinx docs now show v1.1.0. I built wheels manually with build and the dist filenames are also v1.1.0.
jared321
changed the title
asemposki
approved these changes
Sep 18, 2024
|
@jared321 Everything looks good, I just added a couple edits to the docs to make sure the docstrings are all consistent. Thanks for finding all of those typos from when we hastily constructed the documentation last year or longer ago! |
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.
@asemposki I did a full review of the changes in this PR. As part of that, I took the liberty of fully converting the docstrings for a utils function to LaTeX. I also updated the version of the package to v1.1.0 since the sphinx docs were showing v1.0.1.
All the changes look good locally and in the RTD rendered as part of the PR. All GH actions passing.
Please do a careful review to make sure that I didn't break any of the content with my changes. Please merge once you are happy with the changes.