initial commit with sphinx docs#113
Open
brandonjnelsonFDA wants to merge 9 commits intomasterfrom
Open
Conversation
…ith Miguels demo (docs_demo), stopping here
Member
Author
|
Working now! Clicking on the "Docs" tab opens up the sphinx page, which includes auto-generated code and other info, now the two sites are merged. To edit sphinx home page, edit this file: docs/sphinx/source/index.rst and any other files in the docs/sphinx/source folder, then when ready to publish, run See the current readme instructions for viewing the site locally. This is still a rough draft but now we can edit and improve the docs website over time |
Member
Author
|
See also's Dhaval's rst docs template which has more simplified examples for using sphinx: https://github.com/DIDSR/rst_template |
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
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.

(docs_sphinx), unclear how to merge with Miguels demo (docs_demo), stopping here
This is quickly copied from PediatricIQphantoms, a nice feature is the autodocumentation of classes and functions:
If we can merge with Miguel's demo, that would be cool, may ask him for help/ideas.
More on sphinx