llvm-project/libcxx/docs/README.txt

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.
[libcxx] Add new Sphinx documentation Summary: This patch adds Sphinx based documentation to libc++. The goal is to make it easier to write documentation for libc++ since writing new documentation in HTML is cumbersome. This patch rewrites the main page for libc++ along with the instructions for using, building and testing libc++. The built documentation can be found and reviewed here: http://efcs.ca/libcxx-docs In order to build the sphinx documentation you need to specify the cmake options `-DLLVM_ENABLE_SPHINX=ON -DLIBCXX_INCLUDE_DOCS=ON`. This will add the makefile rule `docs-libcxx-html`. Reviewers: chandlerc, mclow.lists, danalbert, jroelofs Subscribers: silvas, cfe-commits Differential Revision: http://reviews.llvm.org/D12129 llvm-svn: 245788 2015-08-23 03:40:49 +08:00			`libc++ Documentation`
			`====================`
Remove test commit. llvm-svn: 246912 2015-09-05 13:38:50 +08:00
[libcxx] Add new Sphinx documentation Summary: This patch adds Sphinx based documentation to libc++. The goal is to make it easier to write documentation for libc++ since writing new documentation in HTML is cumbersome. This patch rewrites the main page for libc++ along with the instructions for using, building and testing libc++. The built documentation can be found and reviewed here: http://efcs.ca/libcxx-docs In order to build the sphinx documentation you need to specify the cmake options `-DLLVM_ENABLE_SPHINX=ON -DLIBCXX_INCLUDE_DOCS=ON`. This will add the makefile rule `docs-libcxx-html`. Reviewers: chandlerc, mclow.lists, danalbert, jroelofs Subscribers: silvas, cfe-commits Differential Revision: http://reviews.llvm.org/D12129 llvm-svn: 245788 2015-08-23 03:40:49 +08:00			`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.`
[libc++] NFC: Add note about how the libcxx website gets updated 2021-07-05 22:25:26 +08:00
			`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.`