API documentation updates #1845
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 Report
@@ Coverage Diff @@
## master #1845 +/- ##
==========================================
+ Coverage 44.22% 44.23% +<.01%
==========================================
Files 83 83
Lines 21538 21539 +1
Branches 5645 5645
==========================================
+ Hits 9526 9527 +1
+ Misses 10956 10942 -14
- Partials 1056 1070 +14
Continue to review full report at Codecov.
|
|
Looking good! |
|
Build and deployment are automated as part of the overall documentation. Keeping it up to date is only partially automated due to how we have it set up currently. Long term, it would definitely be advisable to refactor the API to be completely auto-generated (and completely dependent on docstrings), but it would take a bit of effort to do so. |
The class was combined long ago with rmgpy.species.Species
Also fix some docstrings in MBSampledReactor
Use autodoc_default_options instead
This was referenced Dec 13, 2019
Merged
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.
Motivation or Problem
The API documentation is substantially out-of-sync with the current code structure. #1153 is definitely still relevant.
Description of Changes
This PR adds a bunch of un-documented modules to the API documentation and also fixes various issues with docstrings so that they can be displayed properly.
Testing
The documentation has been compiled to verify that the changes look correct.
To Do
This PR does not exhaustively update the API documentation, i.e. there are still portions of the code which are not included. While adding documentation pages is easy, some decision-making is required in choosing how to organize and format the documentation.
Here's a partial list of modules which are not documented:
I'm not sure how many of these could/should be documented before the release. Contributions from others would be necessary if we want them to be documented.