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.

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

Automate documentation creation #142

Open
stdevel opened this issue Feb 10, 2021 · 1 comment
Open

Automate documentation creation #142

stdevel opened this issue Feb 10, 2021 · 1 comment

Comments

@stdevel
Copy link
Owner

stdevel commented Feb 10, 2021

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
Copy link
Collaborator

okin commented Feb 11, 2021

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants