pulumi/docs/documentation.md

Documentation

Documentation is built with Sphinx and authored in Markdown as much as possible. Markdown support for Sphinx is provided by MyST, which provides a number of extensions to the Markdown dialect you may be used to in order to take advantage of various Sphinx features.

Workflow

Building

The docs directory contains a Makefile (gh-file:pulumi#docs/Makefile) for working with the documentation. Generally you'll just want:

make -C docs watch

which will watch for changes and rebuild the documentation as needed, serving the results at http://localhost:8000. If you want to build the documentation without watching for changes, you can use the build target instead:

make -C docs build

build will compile documentation to a static HTML website in the docs/_build directory; you can open the README.html file in your browser to view the built files from there:

open docs/_build/docs/README.html

:maxdepth: 1
:titlesonly:

/docs/writing
/docs/diagrams