1*60517a1eSAndroid Build Coastguard Worker# Docgen using Sphinx with Bazel 2*60517a1eSAndroid Build Coastguard Worker 3*60517a1eSAndroid Build Coastguard WorkerThe `sphinxdocs` project allows using Bazel to run Sphinx to generate 4*60517a1eSAndroid Build Coastguard Workerdocumentation. It comes with: 5*60517a1eSAndroid Build Coastguard Worker 6*60517a1eSAndroid Build Coastguard Worker* Rules for running Sphinx 7*60517a1eSAndroid Build Coastguard Worker* Rules for generating documentation for Starlark code. 8*60517a1eSAndroid Build Coastguard Worker* A Sphinx plugin for documenting Starlark and Bazel objects. 9*60517a1eSAndroid Build Coastguard Worker* Rules for readthedocs build integration. 10*60517a1eSAndroid Build Coastguard Worker 11*60517a1eSAndroid Build Coastguard WorkerWhile it is primarily oriented towards docgen for Starlark code, the core of it 12*60517a1eSAndroid Build Coastguard Workeris agnostic as to what is being documented. 13*60517a1eSAndroid Build Coastguard Worker 14*60517a1eSAndroid Build Coastguard Worker 15*60517a1eSAndroid Build Coastguard Worker```{toctree} 16*60517a1eSAndroid Build Coastguard Worker:hidden: 17*60517a1eSAndroid Build Coastguard Worker 18*60517a1eSAndroid Build Coastguard Workerstarlark-docgen 19*60517a1eSAndroid Build Coastguard Workersphinx-bzl 20*60517a1eSAndroid Build Coastguard Worker``` 21