<div dir="ltr"><br><div class="gmail_extra"><br><div class="gmail_quote">On Thu, Apr 6, 2017 at 6:17 PM, Tanya Lattner via llvm-dev <span dir="ltr"><<a href="mailto:llvm-dev@lists.llvm.org" target="_blank">llvm-dev@lists.llvm.org</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><span class="gmail-"><br>
> On Apr 6, 2017, at 2:52 AM, Renato Golin <<a href="mailto:renato.golin@linaro.org">renato.golin@linaro.org</a>> wrote:<br>
><br>
> On 6 April 2017 at 05:49, Dean Michael Berris <<a href="mailto:dean.berris@gmail.com">dean.berris@gmail.com</a>> wrote:<br>
>> I'll have a look if I can untangle that.<br>
>><br>
>> Thanks Renato!<br>
><br>
> Well, that didn't last long. Now I remember why last time I fixed<br>
> hundreds of warnings on the docs directly instead of fixing the<br>
> server...<br>
><br>
><br>
>> Has anybody looked into potentially getting the LLVM docs hosted on<br>
>> <a href="http://readthedocs.org" rel="noreferrer" target="_blank">readthedocs.org</a> and automatically built from the LLVM Git mirror (or through<br>
>> Subversion post-commit hooks)? Since we're already using Sphinx, this seems<br>
>> like a low-cost, low-interference way of hosting the generated<br>
>> documentation.<br>
><br>
> This is actually a very good idea. I'll let Tanya and Anton further<br>
> comment on that from a foundation's point of view.<br>
<br>
</span>The docs are built via SVN post-commit hook, but thats not the bigger issue in my opinion. I don’t know enough about <a href="http://readthedocs.org" rel="noreferrer" target="_blank">readthedocs.org</a> but if someone has a lot of experience.. perhaps they could summarize pros and cons of using it?<br>
<br>
I’m not opposed to change just need to understand it. I’m actually going to be handing off most of this stuff as soon as I can write the email to the list (sorry its Spring Break here in the US so my time is limited this week). I have someone who is going to help with sys admin on <a href="http://llvm.org" rel="noreferrer" target="_blank">llvm.org</a> and head things up in that area but ideally its a team of people.<br><br></blockquote><div><br></div><div>I don't know the answers re: pros/cons, I've never built anything with readthedocs before. But I was curious about how hard it is to setup so I gave it a whirl. The answer appears to be: not very hard at all. I added a two-line YAML config file but from the docs I read it seems like it was a superfluous step. Most of the work was clicking a handful of buttons on github and readthedocs' websites.</div><div><div><br class="gmail-Apple-interchange-newline"></div></div></div></div><blockquote style="margin:0 0 0 40px;border:none;padding:0px"><div class="gmail_extra"><div class="gmail_quote"><div><div><a href="https://llvm.readthedocs.io/en/latest/">https://llvm.readthedocs.io/en/latest/</a></div></div></div></div></blockquote><div class="gmail_extra"><div class="gmail_quote"><div><div><br></div><div>Apologies for squatting on the project name, I thought the url would be qualified by my username. I'll see how I can get it changed to move out of the way for the LLVM project.</div></div><div><br></div><div>I did a spot check of several pages and couldn't find obvious missing/invalid parts of the docs. This is just llvm and not clang nor any other project, though.</div><div><br></div></div></div><blockquote style="margin:0 0 0 40px;border:none;padding:0px"><div class="gmail_extra"><div class="gmail_quote"><div><a href="https://llvm.readthedocs.io/en/latest/GoldPlugin.html">https://llvm.readthedocs.io/en/latest/GoldPlugin.html</a></div></div></div></blockquote><blockquote style="margin:0 0 0 40px;border:none;padding:0px"><div class="gmail_extra"><div class="gmail_quote"><div><a href="https://llvm.readthedocs.io/en/latest/WritingAnLLVMPass.html">https://llvm.readthedocs.io/en/latest/WritingAnLLVMPass.html</a></div></div></div></blockquote><blockquote style="margin:0px 0px 0px 40px;border:none;padding:0px"><div class="gmail_extra"><div class="gmail_quote"><div><a href="https://llvm.readthedocs.io/en/latest/HowToCrossCompileLLVM.html">https://llvm.readthedocs.io/en/latest/HowToCrossCompileLLVM.html</a></div></div></div></blockquote><div class="gmail_extra"><div class="gmail_quote"><div><br></div><div>Even search works:</div></div></div><blockquote style="margin:0px 0px 0px 40px;border:none;padding:0px"><div class="gmail_extra"><div class="gmail_quote"><div><a href="https://llvm.readthedocs.io/en/latest/search.html?q=bitcode">https://llvm.readthedocs.io/en/latest/search.html?q=bitcode</a></div></div></div></blockquote><div class="gmail_extra"><div class="gmail_quote"><div><br></div><div>-Brian </div></div>
</div></div>