Amina Chabane
a9a58990ed
This PR aims to organise BOLT's docs in preparation for hosting. - Added a landing page into `index.rst`, much like [clang.llvm.org](https://clang.llvm.org/docs/index.html). - Moved Getting Started content from `index.rst` into its own `GettingStarted.rst`. - Enables Markdown content to be rendered. A current [discussion](https://discourse.llvm.org/t/rfc-make-myst-markdown-the-llvm-docs-format-rip-rest/90840) is being had about MD/RST on discourse, but for now I have decided to support the mix of formats currently in BOLT. - Included AArch64 optimization status page. - Fixes some links/anchors. **Landing Page** <img width="531" height="311" alt="image" src="https://github.com/user-attachments/assets/4fa376bf-cdf1-4ad1-8be5-1de57597ac10" /> **Build with Sphinx** `sphinx-build -b html bolt/docs bolt-docs-html` Requires Sphinx and myst_parser.
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.