Automatic documentation with Sphinx and Read the Docs #104
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
|
no need to push your build/ folder. RTD compiles it on their servers |
jcohenadad
reviewed
May 14, 2021
There was a problem hiding this comment.
- do not push the build folder
- since binaries are now in the branch, you should squash and merge
- add this nice image:
https://github.com/sct-pipeline/csa-atrophy/blob/master/csa_atrophy_scheme3.png
|
add blurb about purpose of this project |
jcohenadad
reviewed
May 14, 2021
| @@ -0,0 +1,96 @@ | |||
|  | |||
There was a problem hiding this comment.
do not duplicate the README, just use one
There was a problem hiding this comment.
I removed README from file "doc" because it is no more used for documentation
jcohenadad
reviewed
May 14, 2021
| @@ -0,0 +1,156 @@ | |||
| STATISTICS | |||
There was a problem hiding this comment.
use rst extension, not txt-- same for all files
There was a problem hiding this comment.
I have removed all .txt files because they were not used.
jcohenadad
reviewed
May 14, 2021
docs/subject_dataframe.rst
Outdated
| @@ -0,0 +1,55 @@ | |||
| Subject dataframe | |||
| ================== | |||
There was a problem hiding this comment.
Suggested change
| ================== | |
| ================= |
- change master toctree test
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Up to now documentation had to be updated manually, the use of Read the Docs and sphinx will allow the automation of the documentation.
To check the generated doc, click on the doc badge here:
https://github.com/sct-pipeline/csa-atrophy/tree/docs