[PATCH] D12129: [libcxx] Add new Sphinx documentation

Eric Fiselier via cfe-commits cfe-commits at lists.llvm.org
Tue Aug 18 17:47:54 PDT 2015


EricWF created this revision.
EricWF added reviewers: jroelofs, chandlerc, danalbert, mclow.lists.
EricWF added a subscriber: cfe-commits.

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`. 


http://reviews.llvm.org/D12129

Files:
  CMakeLists.txt
  cmake/Modules/HandleOutOfTreeLLVM.cmake
  cmake/config-ix.cmake
  docs/BuildingLibcxx.rst
  docs/CMakeLists.txt
  docs/README.txt
  docs/TestingLibcxx.rst
  docs/UsingLibcxx.rst
  docs/_static/favicon.ico
  docs/_static/lines.gif
  docs/_static/llvm.css
  docs/_templates/indexsidebar.html
  docs/_templates/layout.html
  docs/_themes/llvm-theme/layout.html
  docs/_themes/llvm-theme/static/contents.png
  docs/_themes/llvm-theme/static/llvm-theme.css
  docs/_themes/llvm-theme/static/logo.png
  docs/_themes/llvm-theme/static/navigation.png
  docs/_themes/llvm-theme/theme.conf
  docs/conf.py
  docs/index.rst

-------------- next part --------------
A non-text attachment was scrubbed...
Name: D12129.32482.patch
Type: text/x-patch
Size: 47846 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/cfe-commits/attachments/20150819/cf87af10/attachment-0001.bin>


More information about the cfe-commits mailing list