similar to: [LLVMdev] Reorganizing the documentation.

On Fri, Jan 11, 2013 at 8:27 PM, Sean Silva <silvas at purdue.edu> wrote: > Hi Daniel, Bill, all, > > Now that the Sphinx conversion is done, I'm going to move forward with > the plan which was discussed in > <http://thread.gmane.org/gmane.comp.compilers.llvm.cvs/115358>. > > The first step is going to be to inline all of the pages that are just > below the

Greetings, As the first step in a move to better organize the documentation, we''re planning to reorganize it into more specific subsections. The proposed subsections are listed below. If you have any feelings about the reorganization or would like to call attention to a need for documentation in one area of the project or another, please feel free to contribute your views

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 Tanya, Last time I noticed a problem with clang-tools-extra docs you could help solving them. If someone else is taking care of this part of the infrastructure now, please redirect appropriately. It looks like docs generated from rst (for LLVM, Clang and clang-tools-extra) don't get updated at the moment. They stopped updating somewhere between r353327

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

Thank you! It seems like new changes in .rst files are picked up quickly now. -- Alex On Thu, Feb 14, 2019 at 7:33 PM Tanya Lattner <tonic at nondot.org> wrote: > This should all be fixed now. > > Thanks, > Tanya > > > On Feb 14, 2019, at 9:50 AM, Tanya Lattner <tonic at nondot.org> wrote: > > Yes, I am working on it. The sub-projects are still having

Yes, I am working on it. The sub-projects are still having issues but the other documentation has been fixed. -Tanya > On Feb 14, 2019, at 3:53 AM, Alexander Kornienko <alexfh at google.com> wrote: > > Tanya, friendly ping. > > On Mon, Feb 11, 2019 at 3:21 PM Alexander Kornienko <alexfh at google.com <mailto:alexfh at google.com>> wrote: > Hi Tanya, >

Hello, All LLVM HTML documents have been converted to reST. This uncovered an issue with 'make install', which installs only *.html files and completely ignores *.rst (it does not invoke Sphinx to process reST). In order to unbreak 'make install', I checked in a Dummy.html file in r170126 to allow 'make install' to proceed. We need some way to integrate normal 'make

Hi, working on the LNT documentation I am wondering about a few things: - LNT documentation recommends to do `easy_install lnt==0.4.2dev` (in the install box on the left side of the title page). The last available version of LNT on pypy is version 0.4.0 from 2012. Are there plans to keep this up to date or should we better remove the entry and not mention pypy packages anymore? - Building the

On Tue, Aug 17, 2010 at 5:25 PM, Chris Lattner <clattner at apple.com> wrote: > > On Aug 17, 2010, at 3:42 PM, OvermindDL1 wrote: > >> >> On Tue, Aug 17, 2010 at 4:09 PM, David A. Greene <greened at obbligato.org> wrote: >>> OvermindDL1 <overminddl1 at gmail.com> writes: >>> >>>> Correction, even the zip by itself is too big,

Hi All, I've been working on some documentation changes for GlobalISel and it looks like they aren't being reflected on llvm.org <http://llvm.org/>. In particular, the change I landed on the 25th Oct (https://github.com/llvm/llvm-project/commit/feab0334f57d) hasn't appeared yet. This commit changed the 'Global Instruction Selection' link at

I'd be fine pulling the pypi (sic) entry, shall I make it so? - Daniel On Tue, Jul 18, 2017 at 11:06 AM Chris Matthews <chris.matthews at apple.com> wrote: > Yep, we should pull that package down, or start to update it. > > The docs builds work for me. Is it possible that is not in your venv or > something like that? > > > On Jul 18, 2017, at 10:48 AM, Matthias

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

I updated the docs to show a pip/svn install like this: pip install svn+http://llvm.org/svn/llvm-project/lnt/trunk <svn+http://llvm.org/svn/llvm-project/lnt/trunk> > On Jul 18, 2017, at 11:24 AM, Kristof Beyls <kristof.beyls at arm.com> wrote: > > >> On 18 Jul 2017, at 20:21, Daniel Dunbar <daniel at zuster.org <mailto:daniel at zuster.org>> wrote:

Hello, all! Help me please to solve problem with Sphinx and its delta index. Configuration file is located in attachment to this topic. ------------------------------------------------------------------- mysql> select id, e_mail from users where e_mail LIKE ''%test%''; -------------------------------------------------------------------

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

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

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

OvermindDL1 <overminddl1 at gmail.com> writes: > On Tue, Aug 17, 2010 at 5:25 PM, Chris Lattner <clattner at apple.com> wrote: >> On Aug 17, 2010, at 3:42 PM, OvermindDL1 wrote: >> >>> >>> On Tue, Aug 17, 2010 at 4:09 PM, David A. Greene <greened at obbligato.org> wrote: >>>> OvermindDL1 <overminddl1 at gmail.com> writes:

I checked all of the man pages generated using Sphinx and I thought that: 1. They all looked mostly identical. 2. When they didn't, I was equally happy with the Sphinx output. Can you provide two specific .1 files one from POD and one from Sphinx that shows an issue you are concerned about. I haven't encountered problems with "Sphinx crashing" generating man pages. This