similar to: Conversion of all docs to RST

On Mon, Dec 24, 2012 at 9:19 PM, "C. Bergström" <cbergstrom at pathscale.com> wrote: > At the bottom > > Created using<a href="http://sphinx.pocoo.org/ > <view-source:http://sphinx.pocoo.org/>">Sphinx</a> 1.1.3. That is the documentation generator which creates generate the HTML page from the .rst files (similar to how LLVM and

On 12/25/12 11:10 AM, Sean Silva wrote: > UML diagrams can be really helpful for explaining how a piece of code > works (such as the diagrams in your klang project on github). > > The main reason I don't draw them is that I haven't found convenient > tools to use which integrate well with my workflow. Doxygen produces > class diagrams, but I would really like to have

Hi Sean Silva and people on our list, >> What tools did you use to generate the diagrams for the klang documentation? I use StarUML. ( http://staruml.sourceforge.net/en/ ) I mentioned about this earlier before on this mail-list. It's a Windows only application and free software. It is good SW. But development is stopped since long ago. The product was originally a commercial one. But

All sounds good to me. I actually did try to follow the Python style when I used the ^^^ thingies for the questions (they're called subsubsections). 4. I'm not sure exactly how to markup the questions. The sphinx FAQ ( > http://sphinx.pocoo.org/faq.html) marks it up as a definition list > (ctrl-f "definition list" http://sphinx.pocoo.org/rest.html). On the > other

Hi, Since I've migrated to a newer linux distro I can't build docs-clang-html. 1. get LLVM 2. cmake -GNinja -DLLVM_ENABLE_SPHINX=YES -DSPHINX_OUTPUT_HTML=YES -DLLVM_BUILD_DOCS=YES ~/llvm 3. ninja docs-clang-html ======================= [1/2] Generating html Sphinx documentation for clang into "/tmp/LLVM/tools/clang/docs/html" FAILED:

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

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.

Hello, ascii package has been updated to version 0.3.2. ascii is a R package for writing asciidoc, txt2tags, sphinx or org documents with embeded R code. See http://eusebe.github.com/ascii/ for some examples. News since version 0.2 are: - new sphinx driver and output (see http://sphinx.pocoo.org/) - new org driver and output (see http://orgmode.org/) - ascii.simple.list method - ftable

Hello, ascii package has been updated to version 0.3.2. ascii is a R package for writing asciidoc, txt2tags, sphinx or org documents with embeded R code. See http://eusebe.github.com/ascii/ for some examples. News since version 0.2 are: - new sphinx driver and output (see http://sphinx.pocoo.org/) - new org driver and output (see http://orgmode.org/) - ascii.simple.list method - ftable

Done. Do you want to see it again or should I simply ship it off to llvm-commits? The only thing I've changed from the original HTML is that I've changed a few missing code pieces into using code markup. And now I've made the changes you requested and I think it looks really good: Each question being a subsection of its own works very well in my opinon. Oh, heck, I might as well

As I read, I'm writing stuff here things come to me: 1. Don't indent the list. Some of the other RST files do this, but it is incorrect since it indents the list! The list is semantically "at the top level" of indentation (it's not a sub-element of anything). 2. don't have that mini "table of contents" list at the beginning. sphinx will generate that itself

Hi all, Trying to do what my subject says. As I'm trying to be better about making packages out of my code, I'd like the packages themselves to be better, which means *.Rd- documenting my code. The thing is, from years of programming other languages prior to landing in the R pond, I've grown accustomed to documenting my functions inline. I'm not just used to it, but I like

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

Sphinx warns that yaml2obj isn't included into any toctree. Where is a logical place to link this? --Sean Silva

Also, why does it say yaml2py?: yaml2obj takes a YAML description of an object file and converts it to a binary file. $ yaml2py input-file .. program:: yaml2py --Sean Silva On Thu, Sep 20, 2012 at 4:59 PM, Michael Spencer <bigcheesegs at gmail.com> wrote: > On Wed, Sep 19, 2012 at 8:25 PM, Sean Silva <silvas at purdue.edu> wrote: >> Sphinx warns that yaml2obj

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

On Wed, Sep 19, 2012 at 8:25 PM, Sean Silva <silvas at purdue.edu> wrote: > Sphinx warns that yaml2obj isn't included into any toctree. Where is a > logical place to link this? > > --Sean Silva No idea, which is why it's not linked :P. Add it anywhere you feel makes sense. - Michael Spencer

On Thu, Sep 20, 2012 at 7:34 PM, Sean Silva <silvas at purdue.edu> wrote: > Also, why does it say yaml2py?: > > yaml2obj takes a YAML description of an object file and converts it to a binary > file. > > $ yaml2py input-file > > .. program:: yaml2py > > --Sean Silva > Oops. Well, yaml kinda looks like Python... Feel free to fix that. - Michael Spencer

Folks, Total newbie here. What is the simplest way to build a single .rst file so that I can look at the generated HTML? I have CMake, Python, and Sphinx installed. ~~ Paul