<div dir="ltr"><div dir="ltr"><br></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Tue, Aug 20, 2019 at 11:54 AM via llvm-dev <<a href="mailto:llvm-dev@lists.llvm.org">llvm-dev@lists.llvm.org</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div dir="ltr"><div dir="ltr"><div dir="ltr"><br></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Tue, Aug 20, 2019 at 12:36 PM Roman Lebedev <<a href="mailto:lebedev.ri@gmail.com" target="_blank">lebedev.ri@gmail.com</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">On Tue, Aug 20, 2019 at 9:25 PM Michael Spencer via llvm-dev<br>
<<a href="mailto:llvm-dev@lists.llvm.org" target="_blank">llvm-dev@lists.llvm.org</a>> wrote:<br>
><br>
> On Mon, Aug 19, 2019 at 12:38 PM via llvm-dev <<a href="mailto:llvm-dev@lists.llvm.org" target="_blank">llvm-dev@lists.llvm.org</a>> wrote:<br>
>><br>
>> Hi everyone. My name is DeForest Richards. I’m the technical writer who was selected to work on the LLVM project as part of the Google Season of Docs program. I’ll be helping to restructure the documentation page(s) to make it easier for new and existing users to navigate the LLVM docs.<br>
>><br>
>><br>
>> I’m currently reviewing the existing docs, so you’ll probably see me posting questions over the next several weeks. That said, I do have a couple of quick questions that I wanted to ask right now…<br>
>><br>
>><br>
>> I noticed that the LLVM Docs currently use Sphinx 1.7.6, which is an older version. (I believe 2.x is the latest version.) Is this intentional? Updating to the latest version of Sphinx is probably low on my list of priorities, but I was just curious if there was a specific reason for keeping the docs at the older version.<br>
><br>
><br>
> There's no specific reason for this.  We setup Sphinx a while ago and only upgraded once to get markdown support (which is now the preferred format for new docs).  The only constraint on upgrading to 2.x would be is it available on our minimum supported platform, or are we willing to have a higher minimum for generating the docs.<br>
There recently was a disscussion about this in phabricator (i think? i<br>
can't seem to find it right now).<br>
That version is way too new, it's not even in debian sid; enforcing it<br>
would be limiting.<br></blockquote><div><br></div><div>Thanks Michael and Roman. That makes sense.</div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
<br>
>><br>
>> Back in 2012, there was a commit that removed the sidebar from the Docs page. Does anyone know/remember why this was done? I checked the commit message but it’s fairly short and doesn’t provide much context.<br>
><br>
><br>
> Who committed it?<br></blockquote><div><br></div><div>Sean Silva's listed as the commit author.</div></div></div></div></blockquote><div><br></div><div><br></div><div>I went back through my mail and found that in r170790 we observed that the sidebar resulted in a redundant table of contents (once from the main table of contents, one in the sidebar). So we removed the sidebar in r170803.</div><div><br></div><div>I couldn't find online email archives going back that far, so I've attached a PDF printout of the thread.</div><div><br></div><div>This issue may have been exacerbated by our stylesheet/theme making things look ugly.</div><div><br></div><div>-- Sean Silva</div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div dir="ltr"><div dir="ltr"><div class="gmail_quote"><div><br></div><div>----</div><div><br></div><div>I had another question that I was going to start a new thread for, but I'll just add here instead...</div><div><br></div><div><p style="margin:0px;font-stretch:normal;line-height:normal;font-family:"Helvetica Neue";color:rgb(228,175,10)"><span style="color:rgb(69,69,69)">ReleaseNotes.rst file - <a href="http://llvm.org/docs/ReleaseNotes.html" target="_blank"><span style="color:rgb(228,175,10)">http://llvm.org/docs/ReleaseNotes.html</span></a></span></p>
<p style="margin:0px;font-stretch:normal;line-height:normal;font-family:"Helvetica Neue";color:rgb(69,69,69);min-height:14px"><br></p>
<p style="margin:0px;font-stretch:normal;line-height:normal;font-family:"Helvetica Neue";color:rgb(69,69,69)">I was reviewing the commit history for this file in Github, and it appears that it's been worked on for quite a while (as in years). Can someone provide some context as to its purpose?</p>
<p style="margin:0px;font-stretch:normal;line-height:normal;font-family:"Helvetica Neue";color:rgb(69,69,69);min-height:14px"><br></p>
<p style="margin:0px;font-stretch:normal;line-height:normal;font-family:"Helvetica Neue";color:rgb(69,69,69)">My guess, based on the commit history, is that it’s a “living” document that folks contribute to for each upcoming release. Meaning it’s constantly being updated. Is my understanding correct? </p></div><div><br></div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
><br>
> - Michael Spencer<br>
Roman<br>
<br>
> _______________________________________________<br>
> LLVM Developers mailing list<br>
> <a href="mailto:llvm-dev@lists.llvm.org" target="_blank">llvm-dev@lists.llvm.org</a><br>
> <a href="https://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-dev" rel="noreferrer" target="_blank">https://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-dev</a><br>
</blockquote></div></div></div>
_______________________________________________<br>
LLVM Developers mailing list<br>
<a href="mailto:llvm-dev@lists.llvm.org" target="_blank">llvm-dev@lists.llvm.org</a><br>
<a href="https://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-dev" rel="noreferrer" target="_blank">https://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-dev</a><br>
</blockquote></div></div>