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

Generate command help from real output #2043

Closed
dnephin opened this issue Sep 14, 2015 · 2 comments
Closed

Generate command help from real output #2043

dnephin opened this issue Sep 14, 2015 · 2 comments

Comments

@dnephin
Copy link

dnephin commented Sep 14, 2015

Right now docs/reference/docker-compose.md is a copy of docker-compose --help and all the docs/reference/*.md files that have the same issue.

We should be able to generate this output instead of copy-paste it into the docs. Trying to keep them sycned will result in the docs always being out of date (they are currently), and a lot of unnecessary work to attempt to keep them up-to-date.

I don't know much about https://gohugo.io/ but it's definitely something it should support. An example of this feature for sphinx can be found here: https://pythonhosted.org/sphinxcontrib-programoutput/

@albers
Copy link

albers commented Sep 15, 2015

Docker used to have a python tool docs-update.py for that purpose.
It was removed, though. Don't know the current solution.

See also moby/moby#9478.

@dnephin
Copy link
Author

dnephin commented Nov 2, 2015

It looks like either gohugoio/hugo#796 or gohugoio/hugo#247 would make this possible.

Putting the content into an environment variable might also work until those are implemented.

I think another blocker is that the docs build only has access to the docs/ subdirectory, which means that it will need to change in some way.

@shin- shin- closed this as completed Jan 25, 2018
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

3 participants