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.

Sign up for GitHub

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

Jump to bottom

Set up doctests #19

Open
terriko opened this issue May 17, 2021 · 0 comments
Open

Set up doctests #19

terriko opened this issue May 17, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@terriko
Copy link
Owner

terriko commented May 17, 2021

@ben-hampson found a doc bug in #18 that definitely wouldn't have happened if I had doctests, so this bug is a reminder that it wouldn't be a bad idea to set up Sphinx Doctests and then automatically build the documentation. (And maybe get it pushed to readthedocs?)

Currently the docs are in Markdown but I'm happy to switch to RestructuredText if that makes this easier.
@terriko terriko added the documentation Improvements or additions to documentation label May 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@terriko