xref: /aosp_15_r20/external/bazelbuild-rules_python/sphinxdocs/tests/sphinx_stardoc/index.md (revision 60517a1edbc8ecf509223e9af94a7adec7d736b8)
1# Sphinx Stardoc Test
2
3This is a set of documents to test the sphinx_stardoc extension.
4
5To build and view these docs, run:
6
7```
8bazel run //sphinxdocs/tests/sphinx_stardoc:docs.serve
9```
10
11This will build the docs and start an HTTP server where they can be viewed.
12
13To aid the edit/debug cycle, `ibazel` can be used to automatically rebuild
14the HTML:
15
16```
17ibazel build //sphinxdocs/tests/sphinx_stardoc:docs
18```
19
20:::{toctree}
21:hidden:
22:glob:
23
24**
25genindex
26:::
27