README.txt
1libc++ Documentation
2====================
3
4The libc++ documentation is written using the Sphinx documentation generator. It is
5currently tested with Sphinx 1.1.3.
6
7To build the documents into html configure libc++ with the following cmake options:
8
9 * -DLLVM_ENABLE_SPHINX=ON
10 * -DLIBCXX_INCLUDE_DOCS=ON
11
12After configuring libc++ with these options the make rule `docs-libcxx-html`
13should be available.
14
15The documentation in this directory is published at https://libcxx.llvm.org. It is kept up-to-date
16by a build bot: https://lab.llvm.org/buildbot/#/builders/publish-sphinx-docs. If you notice that the
17documentation is not updating anymore, please contact one of the maintainers.
18