pulumi/docs/sphinx
Will Jones 1cd86ddee1
Clean up documentation to support the bridge (#17784)
This commit makes a few changes to our developer documentation in order
to make way for pulumi/pulumi-terraform-bridge#2623, which adds Sphinx
developer documentation to the Terraform Bridge. Namely:

* We introduce `intersphinx`, which allows for cross-referencing between
multiple Sphinx documentation sites as though they were in one site. We
won't introduce such links until the bridge documentation is merged and
deployed, but in theory links such as `tfbridge:some-label` will resolve
correctly thereafter.
* We rename the root page from "Home", to "Pulumi developer
documentation", since both the `pulumi/pulumi` and bridge documentation
sites will have a root and it could be confusing if they were both
called "Home".
* While we're here, we copy a trick from the bridge PR that allows us to
just write Mermaid diagrams using `mermaid` instead of `{mermaid}`. This
means that GitHub will render them in our Markdown files, which is nice.
2024-11-15 14:41:07 +00:00
..
_ext Introduce Sphinx-backed developer documentation (#16953) 2024-08-22 12:20:20 +00:00
_static Introduce Sphinx-backed developer documentation (#16953) 2024-08-22 12:20:20 +00:00
conf.py Clean up documentation to support the bridge (#17784) 2024-11-15 14:41:07 +00:00
index.html.template Introduce Sphinx-backed developer documentation (#16953) 2024-08-22 12:20:20 +00:00