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

Investigate runnable example documentation in ReadTheDocs #672

Closed
drewoldag opened this issue Sep 28, 2023 · 1 comment · Fixed by #824
Closed

Investigate runnable example documentation in ReadTheDocs #672

drewoldag opened this issue Sep 28, 2023 · 1 comment · Fixed by #824
Labels
enhancement New feature or request

Comments

@drewoldag
Copy link
Contributor

@mjuric brought this up during our sync meeting, and no one had a chance to investigate, so we're documenting it here so it won't fall off the backlog.

"Determine if there’s a way to make documentation examples runnable. Some utility with ReadTheDocs that allows marking a block of code as runnable, so that it exists as a unit test. In particular, the “getting started” CLI stuff."

@mschwamb mschwamb added the enhancement New feature or request label Sep 30, 2023
@mschwamb
Copy link
Collaborator

I think this is what we need to be using https://www.sphinx-doc.org/en/master/usage/extensions/doctest.html

mschwamb added a commit that referenced this issue Feb 17, 2024
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants