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

Test documentation routes #49

Open
jmunoznaranjo opened this issue Mar 9, 2016 · 1 comment
Open

Test documentation routes #49

jmunoznaranjo opened this issue Mar 9, 2016 · 1 comment

Comments

@jmunoznaranjo
Copy link
Contributor

We need a way of checking that the routes specified in the docs are valid after changes in the code, as suggested in #41

@NicolasT
Copy link

NicolasT commented Mar 9, 2016

In reply to #41 (comment):

I don't know any offhand tool for this specific scenario (next to http://www.sphinx-doc.org/en/stable/ext/doctest.html), though it can't be too hard to grab some Markdown parsing library which allows to convert an MD source into an AST or has SAX-style parsing features (i.e. goes beyond a single function turning MD into HTML :-)), then find every code block, split the command line out of it (there's somewhat of a pattern in the document, so splitting on first { and dropping the $ should do) and split out the command output, then actually run the command and compare to the documented output.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants