[Lldb-commits] [PATCH] D55376: Generate LLDB website/documentation from rst with Sphinx

[Jonas Devlieghere via Phabricator via lldb-commits]

JDevlieghere created this revision.
JDevlieghere added a reviewer: LLDB.
Herald added subscribers: teemperor, arphaman, mgorny.

The current LLDB website is written in HTML which is hard to maintain. We have quite a bit of HTML code checked in which can make it hard to differentiate between documentation written by us and documentation generated by a tool. Furthermore I think text/RST files provide a lower barrier for new or casual contributors to fix or update.

In line with the other LLVM projects I propose generating the documentation with Sphix. This patch adds a new target `docs-lldb-html` when `-DLLVM_ENABLE_SPHINX:BOOL` is set enabled. I've ported over some pages to give an idea of what this would look like in-tree. Before continuing with this rather tedious work I'd like to get feedback form the community.

Initially I started with the theme used by Clang because it's a default theme and doesn't require configuration. If we want to keep the sidebar we could use the one used by LLD.


Repository:
  rLLDB LLDB

https://reviews.llvm.org/D55376

Files:
  docs/CMakeLists.txt
  docs/conf.py
  docs/index.rst
  docs/resources/test.rst
  docs/status/about.rst
  docs/status/features.rst
  docs/status/goals.rst
  docs/status/projects.rst
  docs/status/status.rst
  docs/use/tutorial.rst

-------------- next part --------------
A non-text attachment was scrubbed...
Name: D55376.176988.patch
Type: text/x-patch
Size: 78858 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/lldb-commits/attachments/20181206/294bc9bf/attachment-0001.bin>