Fit model doc generation #246
Closed
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
Collaborator
|
@nkanazawa1989 Is this PR still relevant? |
Collaborator
Author
|
This is kind of docs automation but not mandatory. I'll close this for now and reopen when we find this is necessary. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Summary
This is follow-up of #238 (has dependency on it)
Details and comments
With #238 fit model description is moved from docstring to
SeriesDefso that it can pass the model description to the analysis result. This PR allows aCurveAnalysissubclass docstring to automatically generate the fit model documentation by taking series definitions.As an example, I only updated RB and IRB analysis documentation since they are ready for migration. You can check appearance of documentation by running
please try
tox -r -edocsif you haven't run docs generation after #116