similar to: [RFC] Markdown for documentation

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

+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

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.

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

On Fri, Mar 30, 2018 at 1:56 AM, David Chisnall <theraven at theravensnest.org> wrote: > On 29 Mar 2018, at 21:25, 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

On Tue, Aug 20, 2019 at 9:25 PM Michael Spencer via llvm-dev <llvm-dev at lists.llvm.org> wrote: > > On Mon, Aug 19, 2019 at 12:38 PM via llvm-dev <llvm-dev at lists.llvm.org> wrote: >> >> 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

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.

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 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 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

Last night, I triggered a buildbot error after my most recent commit. That one was totally on me as the warning did pop up while generating the docs site locally using the sphinx-build command (confirmed this afternoon). I just checked in a commit to resolve the error but now it appears I've triggered a different buildbot error? This error did not come up when I built the site locally to test

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

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.

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 can create html, pdf and epub, then put them on <https://github.com/Jonathan2251/lbd/tree/gh-pages>. The uvbook example as below can click the pdf link and pop up a download window while I cannot. The uvbook link is put on http://username.github.com/... while the "make gh-pages" put them on https://github.com/username/...  How can I have the download link like uvbook

Hello list, I use LLVM's vimrc and found that this setting below is useful when editing of reStructuredText file. llvm/utils/vim/vimrc " Enable syntax highlighting for reStructuredText files. To use, copy " rest.vim (http://www.vim.org/scripts/script.php?script_id=973) " to ~/.vim/syntax . augroup filetype au! BufRead,BufNewFile *.rst set filetype=rest augroup END

I'm pleased to announce the release of Pandoc 0.3, with many improvements and bug fixes. Highlights: - A real markdown parser, not based on regex substitutions. - [More accurate] and [faster], in many cases, than Markdown.pl. - Multiple output formats--HTML, Docbook, LaTeX, reStructuredText, RTF, S5 slide shows--all generated natively, with no XSLT postprocessing. - Converts *to* markdown

Hi, Thanks for bringing this up. I am reluctant to update to recommonmark >= 0.4.0, because it is not available in any Ubuntu version, Debian Testing or even Debian Unstable. While we could do something custom on the buildbot, I think it would be a disservice for our users to use a library that is not packaged in modern operating systems yet. Dmitri