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

Autogenerate README CLI interface documentation #2

Open
DM-Berger opened this issue Jan 11, 2022 · 1 comment
Open

Autogenerate README CLI interface documentation #2

DM-Berger opened this issue Jan 11, 2022 · 1 comment
Assignees
@DM-Berger
Labels
documentation Improvements or additions to documentation todo

Comments

@DM-Berger
Copy link
Collaborator

Probably just use some simple templating would work here to keep one source of truth re: CLI options.
@DM-Berger DM-Berger added documentation Improvements or additions to documentation todo labels Jan 11, 2022
@DM-Berger DM-Berger self-assigned this Jan 11, 2022
@DM-Berger
Copy link
Collaborator Author

I am doing this sort of manually now via python df-analyze.py --help > docs/arguments.py, which could be improved to be a GitHub action or Git hook. Additionally, rather than just spewing to a .txt file, we could take a few seconds to generate a markdown or .html file instead.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@DM-Berger DM-Berger

Labels
documentation Improvements or additions to documentation todo
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@DM-Berger