🎨 docs: Automatically creates oks-cli documentation#24
Open
emmanuel-quevillon-outscale wants to merge 1 commit intomainfrom
Open
🎨 docs: Automatically creates oks-cli documentation#24emmanuel-quevillon-outscale wants to merge 1 commit intomainfrom
emmanuel-quevillon-outscale wants to merge 1 commit intomainfrom
Conversation
…n (tag) is created
emmanuel-quevillon-outscale
requested a review
from anton-kutin
as a code owner
emmanuel-quevillon-outscale
requested review from
outscale-rce,
outscale-rde and
outscale-ykr
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
1 participant
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.
This Pull request is a proposal.
The idea is to automatically generate documentation about
oks-clicommands and subcommands usingmkdocsand a dedicated extensions https://pypi.org/project/mkdocs-click.At the moment there's nothing fixed regarding the structured documentation, we can review it, the same for the look of the generated HTML pages (now it is set to mkdocs-material).
The action is triggered on a tag creation, but can be configured for anything else of course.
TODO: Configure the repo in order to create GitHub pages on GitHub action. Unless you'd like to push the documentaion somewhere else ? Readthedocs ? Outscale?
I repeat, this PR is just a proposal, but I think it could be a good way of having such documentation for users as the
oks-clidocumentation provided by official OUTSCALE site is bit out of sync.I'm of course available to discuss about it.
Below a screenshot of what it looks like as it is: