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

2019-01-09 Thread Stefan Gränitz via lldb-dev
Hey Jonas that looks great! And what a nice way to do the review. Two of the pages from "RESOURCES" are in the new docs now: Testing LLDB and The SB API Coding Rules Will they be removed from the root page and/or do the others follow? Added a few notes on escape characters to the review. > The

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

2019-01-08 Thread Jonas Devlieghere via lldb-dev
For those interested, I've uploaded the latest version of the generated HTML: https://jonasdevlieghere.com/static/lldb/ I'd have to double check but I think that almost everything was ported over. The biggest issue is that the GDB to LLDB command map is totally unreadable with the RST generated

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

2019-01-08 Thread Stefan Gränitz via lldb-dev
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 > wrote: > > Hi everyone, > > The current LLDB website is

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

2018-12-07 Thread Jonas Devlieghere via lldb-dev
> On Dec 7, 2018, at 4:37 AM, Bruce Mitchener via lldb-dev > wrote: > >> On Fri, Dec 7, 2018 at 6:11 PM Raphael Isemann via lldb-dev >> wrote: >> I think if we want to actually lower the entry barrier for >> contributing/fixing things on the website, then the server should do >> this. From

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

2018-12-07 Thread Raphael Isemann via lldb-dev
I think if we want to actually lower the entry barrier for contributing/fixing things on the website, then the server should do this. From what I know the other LLVM projects also generate the HTML on the server (at least I've never seen anyone commit generated HTML files), so this hopefully

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

2018-12-07 Thread 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

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

2018-12-06 Thread Bruce Mitchener via lldb-dev
I like this a lot! I commented on the patch since I didn't see this thread at the time, but it'd be interesting to perhaps replace Epydoc with Sphinx as well. - Bruce On Fri, Dec 7, 2018 at 12:02 AM Jonas Devlieghere via lldb-dev < lldb-dev@lists.llvm.org> wrote: > Hi everyone, > > The

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

2018-12-06 Thread Jonas Devlieghere via lldb-dev
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