[lldb-dev] [RFC] Using Sphinx to generate documentation

Tue Jan 8 08:51:53 PST 2019

Hi Jonas, I think this is a great effort. Thanks!

My current reviews do some small updates on the build page. Hope this doesn't get in conflict with your work?

Best
Stefan

> On 6. Dec 2018, at 18:02, Jonas Devlieghere via lldb-dev <lldb-dev at lists.llvm.org> wrote:
> 
> Hi everyone,
> 
> 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. I created a patch (https://reviews.llvm.org/D55376 <https://reviews.llvm.org/D55376>) that adds a new target docs-lldb-html when -DLLVM_ENABLE_SPHINX:BOOL is 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.
> 
> Please let me know what you think.
> 
> Thanks,
> Jonas
> _______________________________________________
> lldb-dev mailing list
> lldb-dev at lists.llvm.org
> http://lists.llvm.org/cgi-bin/mailman/listinfo/lldb-dev

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.llvm.org/pipermail/lldb-dev/attachments/20190108/26cd4a67/attachment.html>