mirror of
https://github.com/llvm/llvm-project.git
synced 2025-04-27 12:56:08 +00:00
195015cf67
This adds more information regarding the libc++ coding style and reference that are useful when working on a standard library implementation. This information is based on review comments and tips I give to new contributors an information I wish I'd know when I started working on libc++. Depends on D156051 Reviewed By: #libc, jloser, var-const, ldionne Differential Revision: https://reviews.llvm.org/D156052
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.