Replace Python SDK docs with vanilla Sphinx + Read the Docs theme #10279
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
justinvp
had a problem deploying
to
production
GitHub Actions
Failure
There's no longer a need for the pydocgen tool to drive running sphinx. We can run sphinx-build directly from `scripts/generate_python_docs.sh`.
And add `.doctrees/` and `.buildinfo` to `.gitignore`
`#pulumi-python-sdk` no longer exists (by design).
justinvp
force-pushed
the
justin/python
branch
from
c7ebe25 to
2992627
Compare
This makes it consistent with .NET (and Go and Java). A small change in `pulumi/pulumi-hugo` is also needed to make this work.
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 PR replaces our custom Sphinx-based tool for generating core Python SDK docs with standard docs generated from Sphinx using the Read the Docs theme.
Note: I've changed the left nav's "SDK docs" under Python to open in a new tab, similar to .NET (and Go and Java), since the new Python docs have a different style/layout from the rest of the site. This requires pulumi/pulumi-hugo#3754 to actually make it open in a new tab.
Another note: There is more cleanup and adjustments to be made in the docstrings in https://github.com/pulumi/pulumi/tree/master/sdk/python/lib/pulumi to further improve the styling/formatting of the content in some cases. But that can be done subsequently and will automatically be updated in the site as newer releases of the
pulumiPyPi package are released.Fixes #4615
Fixes #5047
Fixes #6426
Fixes #7000
Fixes #10154
Fixes #10161
Fixes pulumi/pulumi-hugo#434