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

[Pavel Labath via lldb-dev]

On 06/12/2018 18:02, Jonas Devlieghere via lldb-dev 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) 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
> 

Woohoo!

Just to be clear, is the idea to still check in the resulting html files 
to remain compatible with how http://lldb.llvm.org (I have no idea who 
maintains that) works, or do you want to change that as well (e.g., by 
having the server generate the html files locally).

pl