-
Notifications
You must be signed in to change notification settings - Fork 12
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
docs: Generate documentation with sphinx #121
Conversation
This should also close #113 when finished. |
Got internal feedback that maybe gitbook or vuebook might be a "more modern" approach than going back to sphinx... Since everything is markdown the only missing piece would be the pydocs which could probably be converted to md with something like pydoc-markdown |
f825e62
to
c42ae6b
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome work! I only have a little nitpick, otherwise LGTM!
I introduced sphinx docs and just used our Adfinis template (FWIW this can probably be replaced by plain sphinx+configuration at some point, see my PR and its discussion).
- Please download the latest artifact and take a look at it. I'm quite happy with how it looks right now (not perfect, but IMO good enough to be merged)
@cli.command
to@pyaptly.command
incli.py
to make the generated docs more comprehensible.Autodocs
(not very useful but only took like 5 mins... :) )jsonschema
of the configuration file atpyaptly/config.schema.json
main.py
which uses the jsonschema.publish.py
andtest_publish.py
which I added in a separate commit