similar to: RST conversion of NUT documentation

On Fri, Sep 25, 2020 at 4:54 PM Daniel P. Berrangé <berrange@redhat.com> wrote: > > > Yes, I tried, but it fails with > > ../src/util/virfile.c:42:11: fatal error: libutil.h: No such file or > > directory > > You'd have to delete the build dir and re-run meson so that it > auto-detects again. > > OK, that issue seems gone, but ninja reports lots of

On Fri, Sep 25, 2020 at 5:24 PM Andrea Bolognani <abologna@redhat.com> wrote: > On Fri, 2020-09-25 at 10:16 +0100, Daniel P. Berrangé wrote: > > On Fri, Sep 25, 2020 at 05:03:24PM +0800, Wei Wang wrote: > > > /usr/local/bin/rst2html5 --stylesheet= --strict docs/manpages/virsh.rst > > > docs/manpages/virsh.rst:41: (ERROR/3) Error in "code-block"

On Fri, Sep 25, 2020 at 5:35 PM Daniel P. Berrangé <berrange@redhat.com> wrote: > On Fri, Sep 25, 2020 at 05:31:09PM +0800, Wei Wang wrote: > > On Fri, Sep 25, 2020 at 5:24 PM Andrea Bolognani <abologna@redhat.com> > > wrote: > > > > > On Fri, 2020-09-25 at 10:16 +0100, Daniel P. Berrangé wrote: > > > > On Fri, Sep 25, 2020 at 05:03:24PM

On Fri, Sep 25, 2020 at 05:31:09PM +0800, Wei Wang wrote: > On Fri, Sep 25, 2020 at 5:24 PM Andrea Bolognani <abologna@redhat.com> > wrote: > > > On Fri, 2020-09-25 at 10:16 +0100, Daniel P. Berrangé wrote: > > > On Fri, Sep 25, 2020 at 05:03:24PM +0800, Wei Wang wrote: > > > > /usr/local/bin/rst2html5 --stylesheet= --strict docs/manpages/virsh.rst >

On Fri, Sep 25, 2020 at 11:23:57AM +0200, Andrea Bolognani wrote: > On Fri, 2020-09-25 at 10:16 +0100, Daniel P. Berrangé wrote: > > On Fri, Sep 25, 2020 at 05:03:24PM +0800, Wei Wang wrote: > > > /usr/local/bin/rst2html5 --stylesheet= --strict docs/manpages/virsh.rst > > > docs/manpages/virsh.rst:41: (ERROR/3) Error in "code-block" directive: > > > 1

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.

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

I've cherry-picked out the changes from my sphinx branch into an rst only branch for inclusion into 1.2.6. There are two ways you can test this for now: 1. I have a branch on github - https://github.com/dcolish/xapian/tree/rstonly 2. You can apply the attached diff, which is also linked here -> http://paste.pocoo.org/show/397433/ I've looked over the output and it looked okay to me,

On Fri, Sep 25, 2020 at 05:03:24PM +0800, Wei Wang wrote: > On Fri, Sep 25, 2020 at 4:54 PM Daniel P. Berrangé <berrange@redhat.com> > wrote: > > > > > > Yes, I tried, but it fails with > > > ../src/util/virfile.c:42:11: fatal error: libutil.h: No such file or > > > directory > > > > You'd have to delete the build dir and re-run

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

On Fri, 2020-09-25 at 10:16 +0100, Daniel P. Berrangé wrote: > On Fri, Sep 25, 2020 at 05:03:24PM +0800, Wei Wang wrote: > > /usr/local/bin/rst2html5 --stylesheet= --strict docs/manpages/virsh.rst > > docs/manpages/virsh.rst:41: (ERROR/3) Error in "code-block" directive: > > 1 argument(s) required, 0 supplied. > > > > .. code-block:: > > > >

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

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

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

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

Thanks, Journeyer. I applied the patch with r176235. In future, you can submit patches to the llvm-commits mailing list. :) -bw On Feb 27, 2013, at 9:03 PM, Journeyer J. Joh <oosaprogrammer at gmail.com> wrote: > Hello list, > > I use LLVM's vimrc and found that this setting below is useful when > editing of reStructuredText file. > > > llvm/utils/vim/vimrc

Most of the documents (html) are generated using rst2html. So I think a patch to the rst file in llvm/tools/llvmc/doc should be fine. Rajika On Mon, Aug 30, 2010 at 7:59 PM, F van der Meeren <llvm-dev at code2develop.com > wrote: > As I have stated before, I am creating a LLVM-C tutorial. > Now I expect it to be in a final draft form within 2~3 weeks, but how do I > have to

Thank you so much for your hard work! LLVM/Clang is in need of motivated Windows developers willing to put in the time to make the LLVM/Clang experience better on Windows :) Quick note on the reST: instead of using a construct like: **Notice:** If you only want to build 32-bit programs, you do **not** need to install MinGW64. Prefer to use the reStructuredText "admonitions" <