[lldb-dev] LLDB Website

Tue Apr 23 17:42:45 PDT 2019


> On Apr 23, 2019, at 5:06 PM, Jonas Devlieghere <jonas at devlieghere.com> wrote:
> 
> 
> 
> On Tue, Apr 23, 2019 at 5:00 PM Tanya Lattner <tanyalattner at llvm.org <mailto:tanyalattner at llvm.org>> wrote:
> 
> 
>> On Apr 23, 2019, at 11:54 AM, Jonas Devlieghere <jonas at devlieghere.com <mailto:jonas at devlieghere.com>> wrote:
>> 
>> Hey Tanya,
>> 
>> On Tue, Apr 23, 2019 at 11:51 Tanya Lattner <tanyalattner at llvm.org <mailto:tanyalattner at llvm.org>> wrote:
>> Jonas,
>> 
>> Ignore what I said before as these do need to be separate targets. It appears the new targets are running doxygen. This isn’t something we typically do as a post commit hook since it takes awhile. I’ll need to do this via the doxygen nightly script. Any concerns?
>>   
>> That sounds perfect. Can we still do the regular website post commit? 
> 
> Yes, so it will do docs-lldb-html on every commit.
> 
> Perfect! 
>  
> 
> So I am able to generate the cpp reference docs: https://lldb.llvm.org/cpp_reference/index.html <https://lldb.llvm.org/cpp_reference/index.html>
> 
> However, the main website links to https://lldb.llvm.org/cpp_reference/html/index.html <https://lldb.llvm.org/cpp_reference/html/index.html>. Do you want the html in that url? I can change the alias. We strip for other doxygen.
> 
> Let's keep it without the html. I'll update a link on the website and add a redirect. 
>  
> 
> As for python docs, what is required to build those? It's not showing up as a target for me.
> 
> This is probably because you don't have `epydoc` installed (sudo pip install epydoc). 
> I think you'll have to re-run cmake after for it to pick it up. The corresponding target should then be `lldb-python-doc`. 
> 
> https://lldb.llvm.org/cpp_reference/index.html <https://lldb.llvm.org/cpp_reference/index.html>
Well installing epydoc did the trick, but I don’t think the doxygen script is the right place for this target. I have not dug into it yet but it appears to require some LLVM libraries and is building those. I’m letting it finish to verify it builds but I’ll have to sort out the best way of doing this on the server. We have other scripts that generate other documentation that build parts of LLVM. Ideally, I would want to leverage that and reduce build times.

-Tanya
>  
> 
> Thanks,
> Tanya
> 
> Thanks again for doing this.
> 
> Cheers,
> Jonas
>  
> 
> 
>> 
>> 
>> -Tanya
>> 
>> Thank you! 
>> 
>> 
>>> On Apr 23, 2019, at 11:45 AM, Tanya Lattner <tanyalattner at llvm.org <mailto:tanyalattner at llvm.org>> wrote:
>>> 
>>> Anytime new targets are added, the script has to be modified. Is there a way you can put them all under a top level html target? Or is there a reason not to?
>>> 
>>> -Tanya
>>> 
>>>> On Apr 19, 2019, at 12:17 PM, Jonas Devlieghere <jonas at devlieghere.com <mailto:jonas at devlieghere.com>> wrote:
>>>> 
>>>> Hey Tanya,
>>>> 
>>>> Thanks again for migrating the LLDB website so it is generated with Sphinx!
>>>> 
>>>> I made a change yesterday that hasn't been propagated yet. It looks like it might have something to do with http://lists.llvm.org/pipermail/www-scripts/2019-April/007524.html <http://lists.llvm.org/pipermail/www-scripts/2019-April/007524.html>. 
>>>> 
>>>> Also, as the result of this change the following two links are broken:
>>>> 
>>>> https://lldb.llvm.org/cpp_reference/ <https://lldb.llvm.org/cpp_reference/>
>>>> https://lldb.llvm.org/python_reference/ <https://lldb.llvm.org/python_reference/>
>>>> 
>>>> Could we make the script generate those two folders as well? The corresponding CMake target are lldb-cpp-doc and lldb-python-doc.
>>>> 
>>>> Thank you,Or
>>>> Jonas
>>>> 
>>>> PS: I've included lldb-dev in CC so everyone knows we're working on the missing documentation. 
>>> 
>> 
>> -- 
>> Sent from my iPhone
> 

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.llvm.org/pipermail/lldb-dev/attachments/20190423/626cdd1c/attachment-0001.html>