-
Notifications
You must be signed in to change notification settings - Fork 211
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
Create an API doc generator for JavaScript and Python #246
Comments
Putting in M16 as a placeholder. |
Pulling this in to see if there's any way to expedite. Not having this is tough, especially since a considerable chunk of figuring out Pulumi is trying to figure out the names of types and properties of the resources you care about. IDE support helps, but is not perfect, and it's even more painful because our names diverge from CloudFormation, ARM, etc., due to Terraform's naming. |
Beta user feedback:
|
We made some good progress on this in 70637ee. The following major steps are remaining:
|
@joeduffy Please make sure your fix for code overflow styling will also also apply to inline blocks such as this one: |
There seems to be a bug that prevents some code from highlighting correctly. See https://docs.pulumi.com/reference/pkg/nodejs/@pulumi/kubernetes/core/v1/#Pod as an example (scroll halfway down the page). |
@swgillespie this is the work item I just mentioned. Putting it into 0.15.1, but if you see any things in the above checklist that are easy wins, and don't have any other urgent issues, let's whittle away at this. |
I've moved the pending work to #492, and I'll close this one out. |
For launch, the current TypeDoc solution is good enough, especially since generated .ts and d.ts files will be available. However, it is very inflexible, so we should explore how to make better generated reference content.
Ideally, we'd split out Python and JavaScript into their own pages, using a layout that is familiar to users of each language.
The text was updated successfully, but these errors were encountered: