Conversation
Contributor
Author
|
This should also close #113 when finished. |
Contributor
Author
|
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
winged
requested changes
Dec 19, 2024
Member
winged
left a comment
There was a problem hiding this comment.
Awesome work! I only have a little nitpick, otherwise LGTM!
winged
approved these changes
Dec 23, 2024
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.commandto@pyaptly.commandincli.pyto make the generated docs more comprehensible.Autodocs(not very useful but only took like 5 mins... :) )jsonschemaof the configuration file atpyaptly/config.schema.jsonmain.pywhich uses the jsonschema.publish.pyandtest_publish.pywhich I added in a separate commit