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

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

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

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

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,

+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

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

Sean, I can create html, pdf and epub, then put them on <https://github.com/Jonathan2251/lbd/tree/gh-pages>. The uvbook example as below can click the pdf link and pop up a download window while I cannot. The uvbook link is put on http://username.github.com/... while the "make gh-pages" put them on https://github.com/username/...  How can I have the download link like uvbook

You may need a ".nojekyll" file. uvbook has one < https://github.com/nikhilm/uvbook/blob/gh-pages/.nojekyll>. Also see < https://help.github.com/articles/files-that-start-with-an-underscore-are-missing >. Let me know if that doesn't work. -- Sean Silva On Mon, Dec 3, 2012 at 9:15 PM, gamma_chen <gamma_chen at yahoo.com.tw> wrote: > Sean, > > I can

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

Hi Jonathan, sorry for the hijack. Can I help you writing the document? Regards, chenwj On Tue, Dec 04, 2012 at 10:15:33AM +0800, gamma_chen wrote: > Sean, > > I can create html, pdf and epub, then put them on > <https://github.com/Jonathan2251/lbd/tree/gh-pages>. > The uvbook example as below can click the pdf link and pop up a download window > while I cannot. The

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

Wei-Ren, Sorry, currently, I have an English helper in documentation. The cpu0 is my brother teaching material for college, and I did llvm backend compiler tutorial  for cpu0 since I didn't find a good tutorial in llvm backend design. As I know, there are many way to contribute back to open source or llvm. For example, write qemu for cpu0 is a extended work in cpu0 llvm backend design. Or