Improve documentation api examples #563
Merged
Conversation
This file contains 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
|
fancy! |
engelmi
force-pushed
the
improve-documentation-api-examples
branch
2 times, most recently
from
07b1e54 to
f41d676
Compare
engelmi
requested review from
alexlarsson,
mkemel,
rhatdan and
sdunnagan
as code owners
mwperina
reviewed
Sep 14, 2023
engelmi
force-pushed
the
improve-documentation-api-examples
branch
4 times, most recently
from
24b0cfb to
49643d9
Compare
mwperina
reviewed
Sep 14, 2023
mwperina
reviewed
Sep 14, 2023
mwperina
reviewed
Sep 14, 2023
By using tabs, the code snippet for the api examples can be grouped by use case and split by language. Unfortunately, the pymdownx.tabbed seems to not work properly with the readthedocs theme. Because of that the theme was exchanged with material. The dependency for it was added. In order to sync tabs with the same title, e.g. multiple tabs for python code, a dedicated js script was added. Signed-off-by: Michael Engel <[email protected]>
Group the api examples by use case and provide them for each language we want to show an example for. Also, instead of only showing snippets, describe a basic setup to run the example code. Adding all examples for Go and a few for C and Rust as well. Signed-off-by: Michael Engel <[email protected]>
engelmi
force-pushed
the
improve-documentation-api-examples
branch
from
49643d9 to
a8e9fe5
Compare
This was referenced Sep 14, 2023
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.
This PR improves the documentation with the API examples as well as about the code generation based on the introspection data.
It contains the following changes:
Pythontab is clicked for the setup, all other tabs follow suit).The changes can be viewed by running mkdocs locally described in https://github.com/containers/bluechi/blob/main/doc/README.md
Some images to showcase the theme change: