Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Regenerate Python docs for all packages #3175

Merged
merged 44 commits into from
Apr 30, 2020

Conversation

praneetloke
Copy link
Contributor

I have Python 3.8 on my macOS and the version of Sphinx that we have pinned for tools/pydocgen does not work unless we upgrade Sphinx to v2.3.1 or later. See sphinx-doc/sphinx#6803. The fix was to disable parallel build in Sphinx on macOS for Python 3.8 sphinx-doc/sphinx#6879. I am not sure if we ever upgraded Sphinx before and if there are things to "watch out" for?

Looking at the diffs, though, I see that the every property, class, method now gets the py css class as well. I also see that output properties have a type associated with it. Not sure if that is Sphinx doing that, or if we recently added those types. Those are the two things I noticed. If this is too much, I can switch to Python 3.7 and regenerate them.

Lastly, you might be wondering what's up with the commit messages saying "NodeJS". Sigh. I wrote a little script to commit the files per-package and I wrote it for the other PR for the NodeJS docs, and forgot to change the commit message while generating the Python docs. I'll fix the commit messages when I "squash and merge", so please ignore the "typo" for now. :)

@praneetloke praneetloke added this to the 0.35 milestone Apr 30, 2020
@praneetloke praneetloke self-assigned this Apr 30, 2020
@github-actions
Copy link

Your site preview for commit aad4551 is now available! 🍹

http://content-bucket-b1cd31a.s3-website-us-east-1.amazonaws.com

Deploy previews powered by Pulumify

Pipfile Outdated Show resolved Hide resolved
Pipfile Outdated Show resolved Hide resolved
Copy link

@pulumi pulumi bot left a comment

Choose a reason for hiding this comment

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

🍹 The Update (preview) for stack pulumi/www.pulumi.com/production was successful.

Resource Changes

    Name                         Type                                          Operation
*   archive-handler              aws:ecs/taskDefinition:TaskDefinition         replaced
~   archive-bucket-callback      aws:lambda/function:Function                  update
~   archive-bucket-subscription  aws:s3/bucketNotification:BucketNotification  update
>-  default-vpc-public-0         aws:ec2/subnet:Subnet                         read
>-  default-vpc-public-1         aws:ec2/subnet:Subnet                         read
>-  default-vpc                  aws:ec2/vpc:Vpc                               read

@github-actions
Copy link

Your site preview for commit 55c409a is now available! 🍹

http://content-bucket-b1cd31a.s3-website-us-east-1.amazonaws.com

Deploy previews powered by Pulumify

Copy link
Member

@justinvp justinvp left a comment

Choose a reason for hiding this comment

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

LGTM

@praneetloke praneetloke merged commit f4f3010 into master Apr 30, 2020
@pulumi-bot pulumi-bot deleted the praneetloke/generate_python_docs branch April 30, 2020 17:36
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.

None yet

2 participants