Fixed documentation build error #1161
Merged
Conversation
This file contains hidden or 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
Added toml to docs requirements and replaced the ConfigParser metadata read. Sphinx also needed to be upgraded for a successful build. This resolves nipy#1160.
Codecov ReportBase: 92.38% // Head: 92.38% // No change to project coverage 👍
Additional details and impacted files@@ Coverage Diff @@
## master #1161 +/- ##
=======================================
Coverage 92.38% 92.38%
=======================================
Files 98 98
Lines 12264 12264
Branches 2520 2520
=======================================
Hits 11330 11330
Misses 613 613
Partials 321 321 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
|
MRG: update doc build Fixes for configuration change. |
effigies
reviewed
Dec 28, 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.
The conf.py file included an extraction of a
[metadata]attribute from setup.cfg usingConfigParser. Since the metadata was moved to pyproject.toml, this raised an exception. To solve this, I added thetomllibrary to the doc requirements and replacedConfigParser.read()withtoml.load(). Sphinx also required a version update to build successfully. This PR resolved #1160.