docs: change from pdoc to sphinx#136
Merged
tmac1973 merged 5 commits intoDec 20, 2023
mainlacework/python-sdk:mainfrom
tmacdonald/GROW-2624/replace-pdoc-with-sphinxlacework/python-sdk:tmacdonald/GROW-2624/replace-pdoc-with-sphinxCopy head branch name to clipboard
Merged
docs: change from pdoc to sphinx#136tmac1973 merged 5 commits intomainlacework/python-sdk:mainfrom tmacdonald/GROW-2624/replace-pdoc-with-sphinxlacework/python-sdk:tmacdonald/GROW-2624/replace-pdoc-with-sphinxCopy head branch name to clipboard
tmac1973 merged 5 commits into
mainlacework/python-sdk:mainfrom
tmacdonald/GROW-2624/replace-pdoc-with-sphinxlacework/python-sdk:tmacdonald/GROW-2624/replace-pdoc-with-sphinxCopy head branch name to clipboard
Conversation
Signed-off-by: Timothy MacDonald <tim.macdonald@lacework.net>
added 2 commits
December 20, 2023 10:15
Signed-off-by: Timothy MacDonald <tim.macdonald@lacework.net>
Signed-off-by: Timothy MacDonald <tim.macdonald@lacework.net>
ipcrm
reviewed
Dec 20, 2023
Contributor
ipcrm
left a comment
There was a problem hiding this comment.
I see a lot of these doctree files are binaries; do we have to check all that in?
Added readme pointing to github pages instead. Signed-off-by: Timothy MacDonald <tim.macdonald@lacework.net>
ipcrm
reviewed
Dec 20, 2023
Contributor
ipcrm
left a comment
There was a problem hiding this comment.
Looks great! Couple quick questions
Update copywrite and tweak docks-build command Signed-off-by: Timothy MacDonald <tim.macdonald@lacework.net>
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
2 participants
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.
Summary:
The old doc generator (pdoc) was not optimal. Sphinx generates much prettier and complete auto documentation.
Testing:
Tested locally on command line using new poe the poet commands
Issue:
https://lacework.atlassian.net/browse/GROW-2624