llvm-capstone/bolt/docs
Tobias Hieta f98ee40f4b
[NFC][Py Reformat] Reformat python files in the rest of the dirs
This is an ongoing series of commits that are reformatting our
Python code. This catches the last of the python files to
reformat. Since they where so few I bunched them together.

Reformatting is done with `black`.

If you end up having problems merging this commit because you
have made changes to a python file, the best way to handle that
is to run git checkout --ours <yourfile> and then reformat it
with black.

If you run into any problems, post to discourse about it and
we will try to help.

RFC Thread below:

https://discourse.llvm.org/t/rfc-document-and-standardize-python-code-style

Reviewed By: jhenderson, #libc, Mordante, sivachandra

Differential Revision: https://reviews.llvm.org/D150784
2023-05-25 11:17:05 +02:00
..
_static [BOLT][Docs] Add Sphinx documentation 2023-01-03 17:39:09 -08:00
CMakeLists.txt [BOLT][Docs] Add Sphinx documentation 2023-01-03 17:39:09 -08:00
conf.py [NFC][Py Reformat] Reformat python files in the rest of the dirs 2023-05-25 11:17:05 +02:00
doxygen-mainpage.dox
doxygen.cfg.in [docs] Hide collaboration and include graphs in doxygen docs 2023-05-04 12:26:51 +02:00
Heatmap.png
Heatmaps.md Allow building heatmaps from basic sampled events with -nl. 2022-04-11 15:04:44 -07:00
index.rst [BOLT][Docs] Add Sphinx documentation 2023-01-03 17:39:09 -08:00
OptimizingClang.md [BOLT] Mark option values of --split-functions deprecated 2022-06-24 17:01:13 -07:00
README.txt [BOLT][Docs] Add Sphinx documentation 2023-01-03 17:39:09 -08:00
RuntimeLibrary.md

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.