similar to: [LLVMdev] [RFC] Moving to Sphinx for LLVM and friends documentation (with partial implementation (in both 10pt and 12pt font)).

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

On Aug 8, 2010, at 11:29 PM, Michael Spencer wrote: > > What Do You Think? > ------------------ > > I realize that changing the documentation format is non-trivial, but I believe > that the benefits are worth the effort. If we go forward with this I will finish > the first two points above and work to integrate doxygen and keep everything > running smoothly. I strongly

On Mon, Aug 9, 2010 at 6:51 PM, Chris Lattner <clattner at apple.com> wrote: > > On Aug 8, 2010, at 11:29 PM, Michael Spencer wrote: >> >> What Do You Think? >> ------------------ >> >> I realize that changing the documentation format is non-trivial, but I believe >> that the benefits are worth the effort. If we go forward with this I will finish

On Mon, Aug 9, 2010 at 8:51 PM, Chris Lattner <clattner at apple.com> wrote: > > On Aug 8, 2010, at 11:29 PM, Michael Spencer wrote: >> >> What Do You Think? >> ------------------ >> >> I realize that changing the documentation format is non-trivial, but I believe >> that the benefits are worth the effort. If we go forward with this I will finish

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:

On Aug 18, 2010, at 4:01 PM, David A. Greene wrote: > And the fact that Boostbook knows how to import Doxygen XML output is a > killer feature. Having a hardcopy of the Doxygen reference can be > really useful. > > I agree with Chris that at the moment, BoostBook/QuickBook is too hard > to set up. I'm certainly not about to use bcp magic and litter my > workspace with

On Wed, Aug 18, 2010 at 3:40 AM, Keir Mierle <mierle at gmail.com> wrote: > Just a random observation from the Python world: Once Sphinx started taking > over as the dominant documentation tool, the quality of Python documentation > greatly improved. This is not just because sphinx produces well formatted > docs; it appears that the real driver behind the improvement is that

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,

AMDG OvermindDL1 wrote: > On Wed, Aug 18, 2010 at 5:03 PM, Chris Lattner <clattner at apple.com> wrote: > >> On Aug 18, 2010, at 4:01 PM, David A. Greene wrote: >> >>> And the fact that Boostbook knows how to import Doxygen XML output is a >>> killer feature. Having a hardcopy of the Doxygen reference can be >>> really useful.

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, here is the 7z, if >>> someone wants a giant zip, I can host it somewhere... >> >> Please do. 7z

On Mon, Aug 9, 2010 at 11:29 PM, Michael Spencer <bigcheesegs at gmail.com> wrote: > You are right that BoostBook is targeted directly for large C++ > projects, and I seriously considered BoostBook for this project, but > ran into a few road blocks. > > * It's tightly integrated into boost and makes quite a few assumptions > about that. What assumptions is that? On

On Tue, Aug 17, 2010 at 4:06 PM, David A. Greene <greened at obbligato.org> wrote: > OvermindDL1 <overminddl1 at gmail.com> writes: > >> On Tue, Aug 10, 2010 at 1:09 PM, David A. Greene <greened at obbligato.org> wrote: >>> BoostBook/QuickBook is really cool but I found it nearly impossible to >>> use outside of the Boost tree. In other words, a few

On Tue, Aug 17, 2010 at 11:09 PM, David A. Greene <greened at obbligato.org> wrote: > Please do.  7z is not supported on Linux. Does not this work? http://packages.debian.org/lenny/p7zip-full Eugene

On Thu, Aug 12, 2010 at 5:52 PM, Aaron Gray <aaronngray.lists at gmail.com> wrote: > poke ! I whipped up a quick example, this is a total of about an hour of work due to finding parameters to set it up, once that is finished though the actual documentation is simple. Look in the html subdirectory to see the generated html as separate files, but it can also generate a single large html

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

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

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