Skip to content

docs: change from pdoc to sphinx#136

Merged
tmac1973 merged 5 commits intomainfrom
tmacdonald/GROW-2624/replace-pdoc-with-sphinx
Dec 20, 2023
Merged

docs: change from pdoc to sphinx#136
tmac1973 merged 5 commits intomainfrom
tmacdonald/GROW-2624/replace-pdoc-with-sphinx

Conversation

@tmac1973
Copy link
Contributor

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

Signed-off-by: Timothy MacDonald <[email protected]>
@tmac1973 tmac1973 requested a review from a team as a code owner December 20, 2023 16:13
Timothy MacDonald added 2 commits December 20, 2023 10:15
Signed-off-by: Timothy MacDonald <[email protected]>
Signed-off-by: Timothy MacDonald <[email protected]>
Copy link
Contributor

@ipcrm ipcrm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 <[email protected]>
Copy link
Contributor

@ipcrm ipcrm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! Couple quick questions

Update copywrite and tweak docks-build command

Signed-off-by: Timothy MacDonald <[email protected]>
Copy link
Contributor

@ipcrm ipcrm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wonderful!

@tmac1973 tmac1973 merged commit da7b2e9 into main Dec 20, 2023
@tmac1973 tmac1973 deleted the tmacdonald/GROW-2624/replace-pdoc-with-sphinx branch December 20, 2023 21:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

Comments