stdevel / katprep

Python toolkit for automating system maintenance and generating patch reports along with Foreman/Katello and Red Hat Satellite 6.x
GNU General Public License v3.0
35 stars 6 forks source link

Automate documentation creation #142

Open stdevel opened 3 years ago

stdevel commented 3 years ago

Is your feature request related to a problem? Please describe. Currently manpagesand Sphinx HTML documentation needs to be created manually - it would be great to have this automated. E.g. in a GitHub actions job - see also issues #135 and #77.

Describe the solution you'd like A GitHub actions job should automatically create the documentation.

Describe alternatives you've considered Some ideas how to automate this: https://github.com/opsi-org/python-opsi#building-the-documentation cc @okin

Additional context

okin commented 3 years ago

General idea: use sphinx-autodoc for creating package documentation and only create handwritten documents to explain things like workflows, concepts etc.

For this to work having the code itself documented is a necessity.