mirror-llvm-project/utils/docs/README.md

# utils/docs

Common configuration and extensions for all of the sphinx projects in the
llvm-project monorepo (e.g. `llvm/docs/`, `clang/docs/`, `bolt/docs`, ...).

This directory is injected into the `PYTHONPATH` of `sphinx-build` processes as
part of the llvm-project CMake build.

**Note:** On the command-line, you must manually ensure this directory is part
of your `PYTHONPATH`. For example, to use `sphinx-autobuild` for projects which
support it, you might use:

```
$ PYTHONPATH=$PWD/utils/docs sphinx-autobuild llvm/docs/ /tmp/sphinx-build
```

## Testing your Environment

To smoke-test your sphinx environment outside of a CMake build, you can use the
`utils/docs/__main__.py` entrypoint (e.g. `python3 utils/docs --test`).
[docs] Create utils/docs (#203962) llvm-project is home to many sphinx documentation sites, each with configuration quirks and bespoke extensions. The sphinx config model makes sharing code somewhat difficult. There are options like sphinx-multiproject, but some of our docs builds are out of the source tree while some are done out of the binary tree, so the multiproject configuration itself would need to be generated. It also would impose more uniformity around extensions than required. This change instead creates a python package at utils/docs/llvm_sphinx and makes it available to all sphinx-build processes via PYTHONPATH. Each conf.py does not modify its own sys.path because not all builds are out of the source tree, so there isn't a stable relative path to use to refer to the utils/docs/ directory. Type checking via pyright in new package is pinned to being python 3.8 compatible. The myst slug script from llvm/docs is promoted to be the default, with a slight edit to targets needed in FlangDriver.md to adapt to the change. The ghlinks extension from clang gets lifted to be the first generic extension, although it is still only used in clang currently. I used it as an example of a general extension that might be useful for other projects, but I also intend to add a new generic extension in a future patch. As part of the move ghlinks is refactored a bit: * Rather than have a main function directly to run its tests, those tests are now run via the command-line entrypoint to the new package, e.g. `python utils/docs --test` will now replace `python clang/docs/ghlinks.py --test`. This makes the command-line more pithy (`python utils/docs/llvm_sphinx/ext/ghlinks --test` is a bit long), and makes the default behavior when running be to include utils/docs in the sys.path, so imports can be absolute and the behavior is as close to the CMake targets as possible. * The static files that were previously written to a tempdir during testing are just committed directly in git. The assumption here is that the original version was taking pains to avoid polluting the clang/docs directory with test files that would confuse sphinx-build, and without that limitation the workaround can be removed. * Some typing-related changes to make it strictly python 3.8 compatible. Change-Id: Ie16de273f74973f163dbf7fe9d22d80a466d051f 2026-06-24 11:12:48 -08:00			`# utils/docs`

			`Common configuration and extensions for all of the sphinx projects in the`
			llvm-project monorepo (e.g. `llvm/docs/`, `clang/docs/`, `bolt/docs`, ...).

			This directory is injected into the `PYTHONPATH` of `sphinx-build` processes as
			`part of the llvm-project CMake build.`

			`Note: On the command-line, you must manually ensure this directory is part`
			of your `PYTHONPATH`. For example, to use `sphinx-autobuild` for projects which
			`support it, you might use:`

			```
			`$ PYTHONPATH=$PWD/utils/docs sphinx-autobuild llvm/docs/ /tmp/sphinx-build`
			```

			`## Testing your Environment`

			`To smoke-test your sphinx environment outside of a CMake build, you can use the`
			`utils/docs/__main__.py` entrypoint (e.g. `python3 utils/docs --test`).