Skip to content

initial commit with sphinx docs#113

Open
brandonjnelsonFDA wants to merge 9 commits intomasterfrom
docs
Open

initial commit with sphinx docs#113
brandonjnelsonFDA wants to merge 9 commits intomasterfrom
docs

Conversation

@brandonjnelsonFDA
Copy link
Copy Markdown
Member

@brandonjnelsonFDA brandonjnelsonFDA commented Feb 13, 2025

(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:

image

If we can merge with Miguel's demo, that would be cool, may ask him for help/ideas.

More on sphinx

…ith Miguels demo (docs_demo), stopping here
@brandonjnelsonFDA
Copy link
Copy Markdown
Member Author

Working now!

image

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 bash build_docs.sh

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

@brandonjnelsonFDA
Copy link
Copy Markdown
Member Author

See also's Dhaval's rst docs template which has more simplified examples for using sphinx: https://github.com/DIDSR/rst_template

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant