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

Improved documentation #23

Open
chr0mag opened this issue Jan 4, 2022 · 0 comments
Open

Improved documentation #23

chr0mag opened this issue Jan 4, 2022 · 0 comments

Comments

@chr0mag
Copy link
Owner

chr0mag commented Jan 4, 2022

The current documentation consists of a README and the --help option generated by argparse.

Some improvements that could be useful:

  1. proper use of comments vs docstrings in the code: https://realpython.com/documenting-python-code/
  2. auto-generating basic documentation - https://docs.readthedocs.io/en/stable/tutorial/
  3. auto-generation of a basic man page - Sphinx has some manpage support (or https://pypi.org/project/argparse-manpage/ ?)

Doing 2 & 3 requires doing 1...
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
No milestone
Development

No branches or pull requests
1 participant
@chr0mag