<div dir="ltr">Appreciate the insight. As part of my project, I'd like to figure out a way to implement a tagging scheme for the docs as I'm sure many topics will fall under multiple categories. The goal would be to provide a way for users to filter topics by category, topic/feature, etc.<br><br>Based on what you and others have said, I'll need to take into consideration that some docs are written in markdown, others in rst.</div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Wed, Aug 21, 2019 at 5:55 AM James Henderson <<a href="mailto:jh7370.2008@my.bristol.ac.uk">jh7370.2008@my.bristol.ac.uk</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>I don't think our current situation for Markdown versus RST is good unfortunately. There are issues with the inter-file links between RST and Markdown documents, so we're actually in the process of changing the new markdown docs for some of the LLVM binary tools to RST in the CommandGuide directory at least. Some related reviews:</div><div><br></div><div><a href="https://reviews.llvm.org/D66305" target="_blank">https://reviews.llvm.org/D66305</a> - switching to RST from MD for new docs<br></div><div><a href="https://reviews.llvm.org/D63292" target="_blank">https://reviews.llvm.org/D63292</a> - attempted workaround for old recommonmark versions</div><div><a href="https://reviews.llvm.org/D63211" target="_blank">https://reviews.llvm.org/D63211</a> - local docs build fix attempt (this thread contains a lot of background on what the problem is)</div><div><br></div><div>And mailing list threads:</div><div><br></div><div><a href="https://lists.llvm.org/pipermail/llvm-dev/2018-March/122234.html" target="_blank">https://lists.llvm.org/pipermail/llvm-dev/2018-March/122234.html</a> - Original proposal to add Markdown support</div><div><a href="http://lists.llvm.org/pipermail/llvm-dev/2019-June/133038.html" target="_blank">http://lists.llvm.org/pipermail/llvm-dev/2019-June/133038.html</a> - My analysis of the problems with different recommonmark and Sphinx versions, which might indicate problems with updating. Follow-up comments point out that only recommonmark 0.4.0 is available on Ubuntu repos, so people didn't want to update the build bots via pip to get a working version.</div><div><br></div><div>To be clear, I have no issues with us using Markdown, or updating our Sphinx etc versions, if they work.</div><div><br></div><div>James<br></div><div><br></div></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Tue, 20 Aug 2019 at 19:37, Roman Lebedev via llvm-dev <<a href="mailto:llvm-dev@lists.llvm.org" target="_blank">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">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>
<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>
><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>
_______________________________________________<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>
</blockquote></div>