Some documentation improvements #77
Conversation
| common patterns with them by passing config options into the constructors for these classes. | ||
| A `Pulumi ComponentResource <https://www.pulumi.com/docs/reference/pkg/python/pulumi/#pulumi.ComponentResource>`_ is a | ||
| collection of related resources. In an effort to follow consistent patterns across infrastructure projects, the | ||
| patterns available in this module all extend a custom class called a :py:class:`tb_pulumi.ThunderbirdComponentResource`. |
There was a problem hiding this comment.
Not sure if this is intended to be a link? But when viewing the file via GitHub preview it does appear as a link
And it just opens to the top of this same getting-started.rst file just FYI.
After reading about RST more I'm guessing this wasn't intended to be a link and it's just that the quotes converted it to a link. I see the same for other :py:class entries elsewhere.
There was a problem hiding this comment.
Yes, the thing to look up is called autodoc. The :py: bit indicates the Python domain.
If I generate the docs locally from this branch, that link looks like this:
And the URL it points to is file:///home/rjung/workspace/thunderbird/pulumi/docs/_build/html/tb_pulumi.html#tb_pulumi.ThunderbirdComponentResource (which is a relative path in the HTML that otherwise directs to the docs domain once published).
This is the result of reading through the docs files (not the inline module/class docs) and improving on language and formatting in a couple places.