similar to: [RFC] Markdown for documentation

I’d love Markdown documentation. It’s easy to read when rendered, easy to read + navigate from a bare-bones text editor, pleasant to write, and has wide adoption. I’m a fan. (If there are any serious missing features, we could probably look into something like Markdeep in the future, which is compatible with Markdown syntax but adds some extra functionality for documentation, writing books, etc.)

I don't like the fact that there are so many different Markdown versions especially when compared to RST, but it does seem that Markdown has become the more popular format. If our tooling supports it and we document what dialect we use (and perhaps even have some form of ninja check-docs to enforce it) I think that this makes sense. -- adrian > On Mar 29, 2018, at 1:25 PM, Michael Spencer

+1, using Markdown should reduce the friction in asking people to write LLVM docs. On Thu, Mar 29, 2018 at 1:42 PM Philip Reames via llvm-dev < llvm-dev at lists.llvm.org> wrote: > Agreed. Markdown is also nice for the github integration. It might make > some of our docs more easily discoverable. (and maybe editable someday) > > On 03/29/2018 01:34 PM, Reid Kleckner via

There's been some desire recently to start writing documentation in Markdown instead of reStructuredText. I put up a [patch]( https://reviews.llvm.org/D44910) for that, but we should figure out a policy on how we want our documentation written first. The desire to use Markdown comes mostly from it being simpler, and having much wider adoption. It does lack some of the feature that

If Sphinx consumes Markdown, great, let's do it. We can migrate docs from .rst to .md easily over time. On Thu, Mar 29, 2018 at 1:26 PM Michael Spencer via llvm-dev < llvm-dev at lists.llvm.org> wrote: > There's been some desire recently to start writing documentation in > Markdown instead of reStructuredText. I put up a [patch]( > https://reviews.llvm.org/D44910) for

Agreed.  Markdown is also nice for the github integration.  It might make some of our docs more easily discoverable.  (and maybe editable someday) On 03/29/2018 01:34 PM, Reid Kleckner via llvm-dev wrote: > If Sphinx consumes Markdown, great, let's do it. > > We can migrate docs from .rst to .md easily over time. > > On Thu, Mar 29, 2018 at 1:26 PM Michael Spencer via

On 5 June 2012 19:48, David Chisnall <theraven at theravensnest.org> wrote: > We plan on holding the next Cambridge LLVM social on Wednesday the 20th of June, from 7:30pm onwards, in The Cambridge Blue: Hi David, Is this today? Are you guys still going? --renato

On 20 Jun 2012, at 17:21, Renato Golin wrote: > On 5 June 2012 19:48, David Chisnall <theraven at theravensnest.org> wrote: >> We plan on holding the next Cambridge LLVM social on Wednesday the 20th of June, from 7:30pm onwards, in The Cambridge Blue: > > Hi David, > > Is this today? Yes. > Are you guys still going? I am, and I believe others are... David

On Wed, Jun 20, 2012 at 5:23 PM, David Chisnall <csdavec at swan.ac.uk> wrote: > On 20 Jun 2012, at 17:21, Renato Golin wrote: > >> On 5 June 2012 19:48, David Chisnall <theraven at theravensnest.org> wrote: >>> We plan on holding the next Cambridge LLVM social on Wednesday the 20th of June, from 7:30pm onwards, in The Cambridge Blue: >> >> Hi David,

I've just released an early version of a Markdown implementation in Haskell (using the Parsec parser combinator library). pandoc converts Markdown to HTML, LaTeX, reStructuredText, rich text format, and S5 HTML slide shows. It partially converts HTML, LaTeX, and reStructuredText to Markdown. It also makes it easy to include LaTeX math on HTML pages, using Peter Jipsen's ASCIIMathML.js.

Hi, TL;DR - We should update the bot(s) responsible for building the LLVM documentation so that they use recommonmark 0.5.0, and apply https://reviews.llvm.org/D63211. Full context: I recently started trying to build the sphinx docs. However, a change by Jordan (r363100) resulted in me no longer being able to build them, even though the build bots were green and he could build them himself.

Hi Michael, Awesome work! I'm a strong supporter of using Sphinx. I've been using it for the LNT docs (http://llvm.org/docs/lnt/) and it is quite nice to work with. +1 for migrating over. - Daniel On Sun, Aug 8, 2010 at 11:29 PM, Michael Spencer <bigcheesegs at gmail.com> wrote: > Moving the LLVM Documentation to Sphinx > ======================================= > >

Michael, The benefits of Sphinx sound nice but one comment: The main page and the tables of contents in the other pages (at least the ones I looked at: Getting Started; Lang Ref) are so long and sparse that it is difficult to get the big picture of what is there and even to find a document unless you know what to search for. The originals were much more compact and so much better in this regard.

Hi I am trying to build  the documentation and view it as html. When I ran the `make docs-llvm-html` target but ran into this below issue. Has anyone faced this issue? ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- % make

On Tue, Feb 12, 2019 at 10:45 AM Jonas Devlieghere <jonas at devlieghere.com> wrote: > Hi Kostya, > > I remember seeing this in the past. IIRC it was sufficient to install > recommonmark with `pip install recommonmark`. > installing this on my machine won't help the bots that build the docs, right? > > Cheers, > Jonas > > On Tue, Feb 12, 2019 at 10:17 AM

Hi, docs seem to be broken. e.g. r353563 adds docs for callbr, but https://llvm.org/docs/LangRef.html doesn't have it. trying to build the docs manually on my box: ninja docs-llvm-html FAILED: docs/CMakeFiles/docs-llvm-html cd /usr/local/google/home/kcc/llvm-build/docs && /usr/bin/sphinx-build -b html -d /usr/local/google/home/kcc/llvm-build/docs/_doctrees-llvm-html -q -W

On Tue, Feb 12, 2019 at 11:05 AM Jonas Devlieghere via llvm-dev < llvm-dev at lists.llvm.org> wrote: > On Tue, Feb 12, 2019 at 10:54 AM Kostya Serebryany <kcc at google.com> wrote: > >> >> >> On Tue, Feb 12, 2019 at 10:45 AM Jonas Devlieghere <jonas at devlieghere.com> >> wrote: >> >>> Hi Kostya, >>> >>> I remember

Moving the LLVM Documentation to Sphinx ======================================= As a few of you that are on IRC already know, I have experimented with moving the LLVM documentation over to `Sphinx <http://sphinx.pocoo.org/index.html>`__ from the current html form. I have moved almost all of the content over and have begun "Sphinxifying" the documentation to correct links and make

Sean, I add the empty file .nojekyll to https://github.com/Jonathan2251/lbd/tree/gh-pages and do "make gh-pages" again. It's the same. I check the uvbook has the gh-pages as mine as follows, https://github.com/nikhilm/uvbook/tree/gh-pages https://github.com/Jonathan2251/lbd/tree/gh-pages In addition to gh-pages, uvbook has the the other web site on

You may need a ".nojekyll" file. uvbook has one < https://github.com/nikhilm/uvbook/blob/gh-pages/.nojekyll>. Also see < https://help.github.com/articles/files-that-start-with-an-underscore-are-missing >. Let me know if that doesn't work. -- Sean Silva On Mon, Dec 3, 2012 at 9:15 PM, gamma_chen <gamma_chen at yahoo.com.tw> wrote: > Sean, > > I can