docs: change from pdoc to sphinx #136
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: Timothy MacDonald <[email protected]>
Signed-off-by: Timothy MacDonald <[email protected]>
Signed-off-by: Timothy MacDonald <[email protected]>
ipcrm
reviewed
Dec 20, 2023
Added readme pointing to github pages instead. Signed-off-by: Timothy MacDonald <[email protected]>
ipcrm
reviewed
Dec 20, 2023
Update copywrite and tweak docks-build command Signed-off-by: Timothy MacDonald <[email protected]>
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.
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