-
Notifications
You must be signed in to change notification settings - Fork 16
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
Find or write a plugin to generate rST from --help #24
Comments
What I do in some of my projects is simply include the output of Here's an example: https://github.com/WoLpH/zfs-utils-osx/blob/master/README.rst |
That does look surprisingly nice... but, before I can feel satisfied enough doing the same to consider this resolved, I'll need to:
|
It's not a 100% solution, just look at the A little bit of googling revealed sphinx-argparse (https://sphinx-argparse.readthedocs.org/en/latest/index.html) which might do the trick, or perhaps sphinxcontrib.autoprogram (https://pythonhosted.org/sphinxcontrib-autoprogram/) Can't say I've tested either, but I might do that soon. Better docs are always useful, the big problem is that I generally want to have the basic usage/parameters in the main readme so it's on Github as well. This makes it a bit hard to automate properly... |
Either of these approaches would work:
In the process, it could commit an updated
I actually ran across an article long ago which explains how to automate testing and output capture for in-article code snippets using a mix of Sphinx, Paver, and Cog. |
Are you sure it's safely possible to let Travis mutate the repo? As far as I know all of the travis configs are public so it would effectively allow everyone to write to the repo. |
http://docs.travis-ci.com/user/encryption-keys/ ...and an example of how to use it to implement ReadTheDocs-like automation for rustdoc: Basically, you create a deploy key (GitHub's term for an SSH key that allows access to only a single repository) and then you use Travis's encryption support to store it in |
That's pretty awesome, I'll have to look into that. Would be great to have fully automated pypi releases and such. Guess I haven't been keeping track of Travis enough... |
Sphinx can generate man pages and has markup roles for the stuff optparse generates for
--help
.So far, I haven't been able to find a
--help
-to-Sphinx plugin so, when time permits, I need to take the--help
-to-manpage script I found a while ago and adapt it into a Sphinx plugin.The text was updated successfully, but these errors were encountered: