75c069584a
Add stub Sphinx documentation, with configuration copy-pasted from lld and index page converted from bolt/README.md. Reviewed By: #bolt, rafauler Differential Revision: https://reviews.llvm.org/D140156
14 lines
393 B
Plaintext
14 lines
393 B
Plaintext
BOLT Documentation
|
|
====================
|
|
|
|
The BOLT documentation is written using the Sphinx documentation generator. It
|
|
is currently tested with Sphinx 1.1.3.
|
|
|
|
To build the documents into html configure BOLT with the following cmake options:
|
|
|
|
* -DLLVM_ENABLE_SPHINX=ON
|
|
* -DBOLT_INCLUDE_DOCS=ON
|
|
|
|
After configuring BOLT with these options the make rule `docs-bolt-html` should
|
|
be available.
|