<div dir="auto">Got it. Thanks!</div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Tue, Aug 20, 2019, 1:59 PM Justin Bogner <<a href="mailto:mail@justinbogner.com">mail@justinbogner.com</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">via llvm-dev <<a href="mailto:llvm-dev@lists.llvm.org" target="_blank" rel="noreferrer">llvm-dev@lists.llvm.org</a>> writes:<br>
> On Tue, Aug 20, 2019 at 12:36 PM Roman Lebedev <<a href="mailto:lebedev.ri@gmail.com" target="_blank" rel="noreferrer">lebedev.ri@gmail.com</a>> wrote:<br>
><br>
>> 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" rel="noreferrer">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" rel="noreferrer">llvm-dev@lists.llvm.org</a>><br>
>> wrote:<br>
>> >><br>
>> >> Hi everyone. My name is DeForest Richards. I’m the technical writer who<br>
>> was selected to work on the LLVM project as part of the Google Season of<br>
>> Docs program. I’ll be helping to restructure the documentation page(s) to<br>
>> 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<br>
>> posting questions over the next several weeks. That said, I do have a<br>
>> 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<br>
>> older version. (I believe 2.x is the latest version.) Is this intentional?<br>
>> Updating to the latest version of Sphinx is probably low on my list of<br>
>> priorities, but I was just curious if there was a specific reason for<br>
>> keeping the docs at the older version.<br>
>> ><br>
>> ><br>
>> > There's no specific reason for this.  We setup Sphinx a while ago and<br>
>> only upgraded once to get markdown support (which is now the preferred<br>
>> format for new docs).  The only constraint on upgrading to 2.x would be is<br>
>> it available on our minimum supported platform, or are we willing to have a<br>
>> 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>
>><br>
><br>
> Thanks Michael and Roman. That makes sense.<br>
><br>
><br>
>><br>
>> >><br>
>> >> Back in 2012, there was a commit that removed the sidebar from the Docs<br>
>> page. Does anyone know/remember why this was done? I checked the commit<br>
>> message but it’s fairly short and doesn’t provide much context.<br>
>> ><br>
>> ><br>
>> > Who committed it?<br>
>><br>
><br>
> Sean Silva's listed as the commit author.<br>
><br>
> ----<br>
><br>
> I had another question that I was going to start a new thread for, but I'll<br>
> just add here instead...<br>
><br>
> ReleaseNotes.rst file - <a href="http://llvm.org/docs/ReleaseNotes.html" rel="noreferrer noreferrer" target="_blank">http://llvm.org/docs/ReleaseNotes.html</a><br>
><br>
><br>
> I was reviewing the commit history for this file in Github, and it appears<br>
> that it's been worked on for quite a while (as in years). Can someone<br>
> provide some context as to its purpose?<br>
><br>
> My guess, based on the commit history, is that it’s a “living” document<br>
> that folks contribute to for each upcoming release. Meaning it’s constantly<br>
> being updated. Is my understanding correct?<br>
<br>
Yes, people add to this when they add changes that should be called out<br>
during the next release. Each time we cut a branch for a release we<br>
"reset" the version of this document on trunk to an empty one.<br>
<br>
>> ><br>
>> > - Michael Spencer<br>
>> Roman<br>
>><br>
>> > _______________________________________________<br>
>> > LLVM Developers mailing list<br>
>> > <a href="mailto:llvm-dev@lists.llvm.org" target="_blank" rel="noreferrer">llvm-dev@lists.llvm.org</a><br>
>> > <a href="https://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-dev" rel="noreferrer noreferrer" target="_blank">https://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-dev</a><br>
>><br>
> _______________________________________________<br>
> LLVM Developers mailing list<br>
> <a href="mailto:llvm-dev@lists.llvm.org" target="_blank" rel="noreferrer">llvm-dev@lists.llvm.org</a><br>
> <a href="https://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-dev" rel="noreferrer noreferrer" target="_blank">https://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-dev</a><br>
</blockquote></div>