| Amir Ayupov | 75c0695 | 2023-01-04 01:38:52 | [diff] [blame] | 1 | BOLT Documentation |
| 2 | ==================== | ||||
| 3 | |||||
| 4 | The BOLT documentation is written using the Sphinx documentation generator. It | ||||
| 5 | is currently tested with Sphinx 1.1.3. | ||||
| 6 | |||||
| 7 | To build the documents into html configure BOLT with the following cmake options: | ||||
| 8 | |||||
| 9 | * -DLLVM_ENABLE_SPHINX=ON | ||||
| 10 | * -DBOLT_INCLUDE_DOCS=ON | ||||
| 11 | |||||
| 12 | After configuring BOLT with these options the make rule `docs-bolt-html` should | ||||
| 13 | be available. | ||||