[llvm] [DirectX][DXIL] Design document for TableGen Spec of DXIL Operations (PR #85170)

S. Bharadwaj Yadavalli via llvm-commits llvm-commits at lists.llvm.org
Thu May 30 11:55:38 PDT 2024


bharadwajy wrote:

> @bharadwajy this seems to break the docs build with:
> 
> ```
> [1/2] Generating man Sphinx documentation for llvm into "/home/runner/work/llvm-project/llvm-project/llvm-build/docs/man"
> FAILED: docs/CMakeFiles/docs-llvm-man /home/runner/work/llvm-project/llvm-project/llvm-build/docs/CMakeFiles/docs-llvm-man 
> cd /home/runner/work/llvm-project/llvm-project/llvm-build/docs && /usr/local/bin/cmake -E env /opt/hostedtoolcache/Python/3.11.9/x64/bin/sphinx-build -b man -d /home/runner/work/llvm-project/llvm-project/llvm-build/docs/_doctrees-llvm-man -q -t builder-man -D version=19 -D release=19.0.0git -tPreRelease -W /home/runner/work/llvm-project/llvm-project/llvm/docs /home/runner/work/llvm-project/llvm-project/llvm-build/docs/man
> 
> Warning, treated as error:
> /home/runner/work/llvm-project/llvm-project/llvm/docs/DirectX/DXILOpTableGenDesign.rst:document isn't included in any toctree
> ```
> 
> See for example: https://github.com/llvm/llvm-project/actions/runs/9306373243/job/25615439087?pr=93801

@jayfoad Thanks for letting me know of this. I have a [change](https://github.com/llvm/llvm-project/compare/main...bharadwajy:llvm-project:dxil_td/design-doc-toctree) that I believe would fix this failure. However, I am unable to verify it on my dev machines as I see the following failure.

```
Warning, treated as error:
cannot cache unpickable configuration value: 'myst_heading_slug_func' (because it contains a function, class, or module object)
```

I have not found a way to address this issue after a quick internet search. Would you have any suggestions?

https://github.com/llvm/llvm-project/pull/85170


More information about the llvm-commits mailing list