mirror of
https://github.com/capstone-engine/llvm-capstone.git
synced 2024-11-23 13:50:11 +00:00
d301539b77
As a new contributor, I found it hard to find the documentation for the meaning of the names of different tests and how those names translate to Lit. This patch moves the documentation to the RST documentation we publish on the website instead of leaving it in the source code only. |
||
|---|---|---|
| .. | ||
| DesignDocs | ||
| Helpers | ||
| ReleaseNotes | ||
| Status | ||
| AddingNewCIJobs.rst | ||
| BuildingLibcxx.rst | ||
| CMakeLists.txt | ||
| conf.py | ||
| Contributing.rst | ||
| FeatureTestMacroTable.rst | ||
| Hardening.rst | ||
| ImplementationDefinedBehavior.rst | ||
| index.rst | ||
| Modules.rst | ||
| README.txt | ||
| ReleaseProcedure.rst | ||
| TestingLibcxx.rst | ||
| UsingLibcxx.rst | ||
libc++ Documentation ==================== The libc++ documentation is written using the Sphinx documentation generator. It is currently tested with Sphinx 1.1.3. To build the documents into html configure libc++ with the following cmake options: * -DLLVM_ENABLE_SPHINX=ON * -DLIBCXX_INCLUDE_DOCS=ON After configuring libc++ with these options the make rule `docs-libcxx-html` should be available. The documentation in this directory is published at https://libcxx.llvm.org. It is kept up-to-date by a build bot: https://lab.llvm.org/buildbot/#/builders/publish-sphinx-docs. If you notice that the documentation is not updating anymore, please contact one of the maintainers.