You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I've been spending this week figuring out how to run doctests individually for modules in VCS.
To that end, I started using doctest.testmod, which enabled me to make a python script that runs testmod for an individual module. If given the correct commnd-line options, it will also parse a results file for the doctest and create a (simple) .md-formatted log for easy viewing.
I needed to run the tests individually because there is no good way of completely cleaning VCS up without just tearing it down and starting a fresh session. Sphinx's built-in doctest extension didn't allow me to do that. So the process now if for me to run a shell script which runs all the doctests in individual modules, and then logs the relevant results into .md files.
@chaosphere2112 @charlesdoutriaux @aashish24 @williams13 ,
Tagging you all because you're involved in the documentation process for VCS.
This is more an update than a real issue.
tl;dr I made stuff that removed the pain of doctesting VCS:
where doctests are needed && which doctests are failing && python script && shell script
Feel free to tell me if I'm doing something wrong
I've been spending this week figuring out how to run doctests individually for modules in VCS.
To that end, I started using doctest.testmod, which enabled me to make a python script that runs testmod for an individual module. If given the correct commnd-line options, it will also parse a results file for the doctest and create a (simple) .md-formatted log for easy viewing.
I needed to run the tests individually because there is no good way of completely cleaning VCS up without just tearing it down and starting a fresh session. Sphinx's built-in doctest extension didn't allow me to do that. So the process now if for me to run a shell script which runs all the doctests in individual modules, and then logs the relevant results into .md files.
What I've ended up with this week is a much clearer picture of where doctests are needed, and which doctests are failing.
Let me know if there's any questions/concerns/comments to my approach.
The text was updated successfully, but these errors were encountered: