xref: /aosp_15_r20/external/bazelbuild-rules_python/sphinxdocs/docs/index.md (revision 60517a1edbc8ecf509223e9af94a7adec7d736b8)
1# Docgen using Sphinx with Bazel
2
3The `sphinxdocs` project allows using Bazel to run Sphinx to generate
4documentation. It comes with:
5
6* Rules for running Sphinx
7* Rules for generating documentation for Starlark code.
8* A Sphinx plugin for documenting Starlark and Bazel objects.
9* Rules for readthedocs build integration.
10
11While it is primarily oriented towards docgen for Starlark code, the core of it
12is agnostic as to what is being documented.
13
14
15```{toctree}
16:hidden:
17
18starlark-docgen
19sphinx-bzl
20```
21