Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

document updates #824

Merged
merged 1 commit into from
Feb 19, 2024
Merged

document updates #824

merged 1 commit into from
Feb 19, 2024

Conversation

mschwamb
Copy link
Collaborator

Fixes #672

Update some doc strings so that there are no warnings.

Update pyproject.toml so that docs install and dev install have same things for sphinx

add in sphinx-exec-directive that let you run python in then docs

Add in runable call to the demo get command function

update some of the doc strings for sorcha_demo_command.py for the returns

add a gitignore entry to files produce by jupyter notebook. for example scripts for multiple core distributed processing

Add additional notebooks previously added to the notebooks.rst that were missing

Remove a small bit about the config file generator functions that were removed.

Fixes  #672

Update some doc strings so that there are no warnings.

Update pyproject.toml so that docs install and dev instal have same things for sphinx

add in sphinx-exec-directive that let you run python in then docs

Add in runable call to the demo get command function

update some of the doc strings for sorcha_demo_command.py for the returns
@mschwamb mschwamb merged commit cfecca8 into main Feb 19, 2024
6 checks passed
@mschwamb mschwamb deleted the doc_updates branch February 19, 2024 15:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Investigate runnable example documentation in ReadTheDocs
2 participants