fgnievinski
commented
1 year ago How about creating a doc page just for the command-line applications, the modules ending in _cl?
Nothing fancy, just an alphabetical list of the existing manual pages:
https://gnssrefl.readthedocs.io/en/latest/api/gnssrefl.daily_avg_cl.html https://gnssrefl.readthedocs.io/en/latest/api/gnssrefl.gnssir_cl.html https://gnssrefl.readthedocs.io/en/latest/api/gnssrefl.installexe_cl.html https://gnssrefl.readthedocs.io/en/latest/api/gnssrefl.invsnr_cl.html https://gnssrefl.readthedocs.io/en/latest/api/gnssrefl.nmea2snr_cl.html https://gnssrefl.readthedocs.io/en/latest/api/gnssrefl.quickLook_cl.html https://gnssrefl.readthedocs.io/en/latest/api/gnssrefl.refl_zones_cl.html https://gnssrefl.readthedocs.io/en/latest/api/gnssrefl.rinex2snr_cl.html https://gnssrefl.readthedocs.io/en/latest/api/gnssrefl.subdaily_cl.html
It could be listed in the docs index page, between Workflow and API Docs?
https://gnssrefl.readthedocs.io/en/latest/ https://github.com/kristinemlarson/gnssrefl/blob/master/docs/index.rst
I'm always browsing the source code on github only to check the input options.
and I don't always have Docker open (it's a memory hog).
the demo/tutorials are superb, but a plain "man page" would be a nice complement.
it could be generated simply as:
gnssir --help > gnssir.helpI'm just not sure where to drop these files, maybe a new subdirectory in docs? https://github.com/kristinemlarson/gnssrefl/tree/master/docs