chr0mag/geoipsets

Improved documentation

Opened this issue · 0 comments

chr0mag commented

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...