xref: /aosp_15_r20/external/libcxx/docs/README.txt (revision 58b9f456b02922dfdb1fad8a988d5fd8765ecb80)
1*58b9f456SAndroid Build Coastguard Workerlibc++ Documentation
2*58b9f456SAndroid Build Coastguard Worker====================
3*58b9f456SAndroid Build Coastguard Worker
4*58b9f456SAndroid Build Coastguard WorkerThe libc++ documentation is written using the Sphinx documentation generator. It is
5*58b9f456SAndroid Build Coastguard Workercurrently tested with Sphinx 1.1.3.
6*58b9f456SAndroid Build Coastguard Worker
7*58b9f456SAndroid Build Coastguard WorkerTo build the documents into html configure libc++ with the following cmake options:
8*58b9f456SAndroid Build Coastguard Worker
9*58b9f456SAndroid Build Coastguard Worker  * -DLLVM_ENABLE_SPHINX=ON
10*58b9f456SAndroid Build Coastguard Worker  * -DLIBCXX_INCLUDE_DOCS=ON
11*58b9f456SAndroid Build Coastguard Worker
12*58b9f456SAndroid Build Coastguard WorkerAfter configuring libc++ with these options the make rule `docs-libcxx-html`
13*58b9f456SAndroid Build Coastguard Workershould be available.
14