This website requires JavaScript.
Explore
ben
ben/packages
Help
Sign In
mirrors
/
pulumi
mirror of
https://github.com/pulumi/pulumi.git
Watch
0
Star
0
Fork
You've already forked pulumi
0
Code
Issues
Packages
Projects
Releases
Wiki
Activity
tg/goproxy-direct
Branches
Tags
No results found.
pulumi
/
docs
/
.gitignore
6 lines
45 B
Plaintext
Raw
Permalink
Normal View
History
Unescape
Escape
Introduce Sphinx-backed developer documentation (#16953) This commit introduces an initial Sphinx configuration for writing repository-wide developer documentation in Sphinx's MyST Markdown. It includes Sphinx and MyST configuration as well as workflows for local development. Documentation on writing documentation -- conventions as well as how to best utilise Sphinx and other tools is included as a starting point, with the intention being to fill out the remainder of the repository in subsequent commits (this will include migrating and deprecating `developer-docs`). Deployment uses the existing "Read the docs" webhook and will overwrite the current live version, which at this point is 6 months' stale anyway.
2024-08-22 12:20:20 +00:00
.ensure.phony
_build
Generate reference documentation from Protobufs (#17120) Protocol buffer (Protobuf) definitions are the source of truth for many of the types and interfaces used across Pulumi products. Documentation written in Protobuf files is already used to generate commented code e.g. when producing gRPC stubs and clients. This commit extends this to generate reference developer documentation from our Protobuf files using the `protoc-gen-doc` plugin for `protoc`, which exports Protobuf documentation as Markdown. This is then incorporated into the build process for our developer documentation so that we can refer to Protobuf types and gRPC services and messages across our documentation. In order to provide a degree of portability, and also not to require developers (or the Read the Docs build process) to download and manage the `protoc` / `protoc-gen-doc` toolchains required, this commit introduces a `make.py` Python script that encapsulates the more complicated steps of the build without having to resort to reams of shell scripts. This script is still invoked from the `Makefile` and Make is still responsible for dependency tracking (e.g. recognising that generating Protobuf documentation must happen before running the Sphinx build, and so on).
2024-08-30 17:04:16 +00:00
_generated
_tools
Introduce Sphinx-backed developer documentation (#16953) This commit introduces an initial Sphinx configuration for writing repository-wide developer documentation in Sphinx's MyST Markdown. It includes Sphinx and MyST configuration as well as workflows for local development. Documentation on writing documentation -- conventions as well as how to best utilise Sphinx and other tools is included as a starting point, with the intention being to fill out the remainder of the repository in subsequent commits (this will include migrating and deprecating `developer-docs`). Deployment uses the existing "Read the docs" webhook and will overwrite the current live version, which at this point is 6 months' stale anyway.
2024-08-22 12:20:20 +00:00
venv/