Bootstrap lambkin-shepherd documentation
#48
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
Signed-off-by: Michel Hidalgo <[email protected]>
|
Also, @francocipollone PTAL. |
francocipollone
approved these changes
May 9, 2023
|
|
||
| ```sh | ||
| cd docs | ||
| make html |
There was a problem hiding this comment.
Not needed to run this within the shell?
poetry run make html
There was a problem hiding this comment.
poetry run is already used within the Makefile.
| @@ -0,0 +1,413 @@ | |||
| import contextlib | |||
There was a problem hiding this comment.
Good catch. Fixed in 2f8554c.
Signed-off-by: Michel Hidalgo <[email protected]>
|
Moving forward. |
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.
Proposed changes
This patch sets up
lambkin-shepherddocumentation usingsphinx. That's easier said than done, as RobotFramework tooling for documentation is... bad, let's stay with bad. ThisautorobotSphinx extension is what I came up with to address that. I was planning to polish the package documentation before submitting this PR, but let's review this first.Connected to #18 and #44.
Type of change
Checklist
Additional comments
This patch is lacking linters for ReST documents. That will come later, with the rest of the documentation. Also, I did not add any tests for the
autorobotextension. I don't think it's worth it.