similar to: Introduction and Question about Docs

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

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

Quick update. I've decided to scratch the idea of using the raw directive to add html to the docs homepage. I realized today that in order to accomplish what I want (add two-column layout with links to individual topics), I would have to use hyperlinks. That seems undesirable given that it would make it easier to break the URL links if the LLVM docs site were ever moved/updated. I spent a few

As part of my Google Season of Docs project, I’ve been conducting a content audit of the LLVM docs. My goal is to identify specific categories and tasks under which the docs can be re-organized. One of my first suggestions will be to turn the main index (llvm.org/docs) into a landing page of sorts. Here’s an example of how the new index page might look: # Welcome/About * Introduction and

Thanks everyone for your suggestions. The doc development phase of the Season of Docs program starts next week. I'll be posting my proposed changes via this mailing list in the next day or so. On Thu, Aug 22, 2019 at 3:05 PM Cranmer, Joshua <joshua.cranmer at intel.com> wrote: > The break-down of “User Guides”, “Programming Documentation”, and > “Subsystem Documentation” has

Hey everyone, I've made several updates to the LLVM docs site over the last few weeks. I'd like to get some feedback before I make any additional changes. As of right now, here are the updates I've made: a.) Added a static sidebar with links to the docs, community pages, etc. b.) Moved the Community/Getting Involved info to a separate page. c.) Consolidate the docs into three

Hi All, I'm working on rewriting libc++'s documentation using Sphinx. Hopefully it will be easier to write and maintain documentation using restructured text and not HTML. What steps do I need to take to get libc++ a Sphinx builder and get the required changes made for libcxx.llvm.org? /Eric

CC Tanya and ping. On Mon, Jul 20, 2015 at 1:41 PM, Eric Fiselier <eric at efcs.ca> wrote: > Hi All, > > I'm working on rewriting libc++'s documentation using Sphinx. > Hopefully it will be easier to write and maintain documentation using > restructured text and not HTML. > > What steps do I need to take to get libc++ a Sphinx builder and get > the required

Hi Eric, On 20 July 2015 at 10:41, Eric Fiselier <eric at efcs.ca> wrote: > Hi All, > > I'm working on rewriting libc++'s documentation using Sphinx. > Hopefully it will be easier to write and maintain documentation using > restructured text and not HTML. > > What steps do I need to take to get libc++ a Sphinx builder and get > the required changes made for

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

> On 3 Apr 2017, at 22:47, Alex Denisov <1101.debian at gmail.com> wrote: > > The HTML generated using sphinx[1]. > At the bottom of each page you can see actual version of sphinx used to generate this page. > Thanks -- interesting that the docs haven't been updated since March 15th: © Copyright 2003-2017, LLVM Project. Last updated on 2017-03-16. Created using Sphinx

Hi -- I've recently added some documentation to the LLVM docs subdirectory, and was wondering about a couple of things: - How should I best debug whether the docs (in RST) are syntactically correct? Are there recommended practices for doing a sanity check on the docs? - How often do the documents get built and uploaded to the website? Cheers -- Dean

On 3 April 2017 at 13:59, Daniel Berlin via llvm-dev <llvm-dev at lists.llvm.org> wrote: > > > On Mon, Apr 3, 2017 at 5:51 AM, Dean Michael Berris via llvm-dev > <llvm-dev at lists.llvm.org> wrote: >> >> >> On 3 Apr 2017, at 22:47, Alex Denisov <1101.debian at gmail.com> wrote: >> >> The HTML generated using sphinx[1]. >> At the

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.

On Fri, Jul 31, 2015 at 12:01 AM, Dan Liew <dan at su-root.co.uk> wrote: > Hi Eric, > > On 20 July 2015 at 10:41, Eric Fiselier <eric at efcs.ca> wrote: >> Hi All, >> >> I'm working on rewriting libc++'s documentation using Sphinx. >> Hopefully it will be easier to write and maintain documentation using >> restructured text and not HTML.

Hi all, It looks like the llvm-sphinx-docs fails for a long time (at least 20 days). Can someone please confirm if this is true? Best regards, Djordje

On 08/01/2018 19:16, Matthias Braun wrote: > I believe the results of the docu generation can be found here: > > http://lists.llvm.org/pipermail/www-scripts/2018-January/thread.html > > (though a nice improvement for the future would be to make this into a > buildbot or jenkins job so people would get direct blame mails) > Thanks Matthias. I had a look at the error

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 7 April 2017 at 15:50, Tanya Lattner <tanyalattner at llvm.org> wrote: > So, building the docs isn't the issue I feel is the problem. The script we > have works totally fine. The problem is people breaking the docs. > > So how is this better? I don't know enough about the website, but there are other problems in our infrastructure: * We need to manually update