Add spinner docs infrastructure #44
Draft
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
|
@rodrigo-ceccato and @leiteg any suggestions for a color palette for the documentation and the landing pages? |
|
@cl3to this theme looks really nice and I fine with the current color! |
leiteg
reviewed
Oct 11, 2024
Comment on lines
+29
to
+50
| ```yaml | ||
| metadata: | ||
| description: Timeout test | ||
| version: "1.0" | ||
| runs: 1 | ||
| timeout: 5 | ||
| retry: False | ||
| retry_limit: 0 | ||
|
|
||
| sleep_test: | ||
| command: | ||
| template: > | ||
| sleep {{sleep_ammount}} && printf " | ||
| I slept {{sleep_ammount}} | ||
| # this may not print due to timeout! | ||
| " | ||
|
|
||
| sleep_test: | ||
| sleep_ammount: | ||
| - 1 | ||
| - 200 | ||
| ``` |
There was a problem hiding this comment.
Keys under metadata and the template key are missing identation!
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 pull request introduces documentation infraestructure for spinner. Key changes include the addition of a detailed
docs/index.mdfile, configuration for the MkDocs documentation site, and updates to thepyproject.tomlto include necessary dependencies.Currently, the documentation is hosted using GitHub Pages at Spinner Documentation.
TODO