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

Add sphinx documentation #40

Closed
ewu63 opened this issue May 7, 2021 · 2 comments
Closed

Add sphinx documentation #40

ewu63 opened this issue May 7, 2021 · 2 comments
Labels
duplicate This issue or pull request already exists

Comments

@ewu63
Copy link
Collaborator

ewu63 commented May 7, 2021

Description

Since this tool is actually somewhat complex, we may want to have a documentation site. This would include both auto-generated documentation (via autoprogram or equivalent), as well as some additional information for some file formats expected by the CLI tool (that don't fit into the help string). Some diagrams etc. may also be helpful.

Note that these Sphinx extensions that parse argparser are somewhat finicky, so #39 will be related to this effort.
@sseraj
Copy link
Collaborator

sseraj commented May 7, 2021

Possibly a duplicate of #14?

@ewu63
Copy link
Collaborator Author

ewu63 commented May 7, 2021

Yep good point.

@ewu63 ewu63 closed this as completed May 7, 2021
@ewu63 ewu63 added the duplicate This issue or pull request already exists label May 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
duplicate This issue or pull request already exists
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@ewu63 @sseraj