Integration of sphinx for documentation generation #74
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
This is initial work to investigate the suitability and features of sphinx for documenting feature calculation formulas, as suggested in #53. It seems that this approach to documentation is a good fit for supporting users of this library, which are developers by intent. The process of setting up and using sphinx is summarized in this wiki entry: https://github.com/Radiomics/pyradiomics/wiki/Documentation-infrastructure Examples of the documented features are kurtosis and skewness in firstorder. Sample screenshots will be added to #53. _build should probably be taken out of the repository, and perhaps _build/html should be replicated into gh-pages branch, once the repository becomes public. Some open questions for discussion: - should modules.rst and radiomics.rst be included in the repository, or generated every time with sphinx-apidoc -f -o . ../radiomics ? - documentation for some of the features (texture, wavelets) is quite extensive and probably does not fit into this format
IMO it is more practical to use python raw strings (r"<content>") instead of regular strings. The use of raw strings allows to use LaTeX math directly, without the need to escape backslashes. This in turn allows to directly paste math formulas generated using WYSIWYG editors such as https://www.codecogs.com/latex/eqneditor.php. See #53
- remove _build folder - remove modules.rst as unnecessary - rename radiomics.rst to radiomics-api.rst
Also, moved radiomics-api.rst back to radiomics.rst, to simplify the contribution process and maintain consistency with the naming conventions used by sphinx-apidoc.
|
Cc: @Radiomics/developers |
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
This addresses #53.
Note that it is a known issue that tests are currently not passing, so this is a caveat for using the current contributing guidelines.
We should definitely have green dashboard before making pyradiomics public!