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.

Sign up for GitHub

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

Jump to bottom

Auto-update usage in README.rst #13

Closed
milkey-mouse opened this issue Dec 13, 2017 · 0 comments
Closed

Auto-update usage in README.rst #13

milkey-mouse opened this issue Dec 13, 2017 · 0 comments
Milestone
0.2

Comments

@milkey-mouse
Copy link
Owner

milkey-mouse commented Dec 13, 2017 •
edited
Loading

When restore-vm (#1) and borg-multi (#6) are both in master, remember to update README.rst with the new content.
Perhaps implement a setup.py build_usage or something, similar to borg? I don't think github includes documents from rst's include directive, so it would have to edit the document in-place. One approach would be to put comments on the lines in the README before and after the usage snippets should be auto-inserted, and generate them by iterating through the entry_points.
@milkey-mouse milkey-mouse added this to the 0.2 milestone Dec 13, 2017
@milkey-mouse milkey-mouse changed the title Update usage in README.rst Auto-update usage in README.rst Dec 13, 2017
@milkey-mouse milkey-mouse mentioned this issue Dec 18, 2017
Open
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
0.2
Development

No branches or pull requests
1 participant
@milkey-mouse