-
-
Notifications
You must be signed in to change notification settings - Fork 653
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
Ensure --help examples in docs are always up to date #336
Comments
Easiest way to do this I think would be to make those help blocks separate files in the docs/ directory (publish-help.txt perhaps) and then include them with a sphinx directive: https://reinout.vanrees.org/weblog/2010/12/08/include-external-in-sphinx.html |
I decided against the unit tests, instead I have a new script called |
Actually I do like the idea of a unit test that reminds me if I've forgotten to update the included files. |
Ideally I would automatically generate the --help output shown in our docs, but I don't think I can get that working with readthedocs.
Instead, I'm going to add a unit test that checks that those extracts in the documentation match the current output of the --help command.
The text was updated successfully, but these errors were encountered: