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

Developments with documentation #107

ghost opened this issue Dec 8, 2016 · 1 comment

Developments with documentation #107

ghost opened this issue Dec 8, 2016 · 1 comment


Copy link

ghost commented Dec 8, 2016

@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.

@ghost ghost added the enhancement label Dec 8, 2016
@ghost ghost self-assigned this Dec 8, 2016
@ghost ghost mentioned this issue Dec 12, 2016
@doutriaux1 doutriaux1 modified the milestone: 3.0 May 5, 2017
@doutriaux1 doutriaux1 modified the milestones: 3.0, post 3.0 Mar 29, 2018
@doutriaux1 doutriaux1 modified the milestones: 8.1, 8.2 Mar 27, 2019
Copy link

doutriaux1 commented Apr 18, 2019

make doctest works these days, closing

@downiec downiec modified the milestones: 8.2, 8.2.1 Jul 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
None yet

No branches or pull requests

2 participants