Re: [boost] New Getting Started Guide
-----Original Message----- From: boost-bounces@lists.boost.org [mailto:boost-bounces@lists.boost.org] On Behalf Of David Abrahams
Yes, I think a link from this document would be great. I remember the first time I built boost I was lost trying to figure out how to reduce the number of built variants.
Who will write the follow-up document? You?
I'd be happy to. Is there a link I should read for how to write these docs for boost?
"Sohail Somani" <s.somani@fincad.com> writes:
-----Original Message----- From: boost-bounces@lists.boost.org [mailto:boost-bounces@lists.boost.org] On Behalf Of David Abrahams
Yes, I think a link from this document would be great. I remember the first time I built boost I was lost trying to figure out how to reduce the number of built variants.
Who will write the follow-up document? You?
I'd be happy to. Is there a link I should read for how to write these docs for boost?
Nope, sorry. I suggest using RestructuredText for consistency with the first document, but that's optional. -- Dave Abrahams Boost Consulting www.boost-consulting.com
David Abrahams wrote:
"Sohail Somani" <s.somani@fincad.com> writes:
Nope, sorry. I suggest using RestructuredText for consistency with the first document, but that's optional.
I'm know this is a little off topic but I'm really curious as to why you chose RsT rather than quickbook for making this document. I've been looking at what's involved in converting the serialization documentation but I'm always wary of new stuff. I'm curious what the advantages/disadvantages are and what the experience has been in creating pdf files from docbook. Robert Ramey
"Robert Ramey" <ramey@rrsd.com> writes:
David Abrahams wrote:
"Sohail Somani" <s.somani@fincad.com> writes:
Nope, sorry. I suggest using RestructuredText for consistency with the first document, but that's optional.
I'm know this is a little off topic but I'm really curious as to why you chose RsT rather than quickbook for making this document.
Lots of reasons: easier installation, I happen to know it really well since we wrote C++TMP in it, more sensible parsing rules, I have complete and working emacs syntax coloring (makes a huge difference), shorter toolchain, a great path to PDFs (please don't say "FOP").
I've been looking at what's involved in converting the serialization documentation but I'm always wary of new stuff. I'm curious what the advantages/disadvantages are and what the experience has been in creating pdf files from docbook.
See the boost-docs list; there were posts about that today. -- Dave Abrahams Boost Consulting www.boost-consulting.com
David Abrahams wrote:
Lots of reasons: easier installation, I happen to know it really well since we wrote C++TMP in it, more sensible parsing rules, I have complete and working emacs syntax coloring (makes a huge difference), shorter toolchain, a great path to PDFs (please don't say "FOP").
Are all of these things already available in boost somewhere? Is it possible for me to set all of this up, too? I also use docutils and emacs, and I would like to generate PDF documentation. I tried writing my own bjam files to convert from rst to latex to pdf, but I'm not particularly good at this. I just found docutils.jam, but I'm not sure whether I have to do anything special to make sure that the docutils scripts are found. Deane
Deane Yang <deane_yang@yahoo.com> writes:
David Abrahams wrote:
Lots of reasons: easier installation, I happen to know it really well since we wrote C++TMP in it, more sensible parsing rules, I have complete and working emacs syntax coloring (makes a huge difference), shorter toolchain, a great path to PDFs (please don't say "FOP").
Are all of these things already available in boost somewhere?
I don't understand what you mean. What things?
Is it possible for me to set all of this up, too?
Sorry, you'll have to be more specific.
I also use docutils and emacs, and I would like to generate PDF documentation. I tried writing my own bjam files to convert from rst to latex to pdf, but I'm not particularly good at this.
That's the path. 'Till now I've used a Makefile for that purpose, but only because I haven't had the time to set up BBv2 to generate pdfs; it would probaby be easy. See http://boost.org/libs/iterator/doc/GNUmakefile for a hint ;-)
I just found docutils.jam, but I'm not sure whether I have to do anything special to make sure that the docutils scripts are found.
If your docutils is installed (e.g. in your Python's site-packages), it's just using docutils ; but I think I only ever wrote RST->HTML support in docutils.jam. -- Dave Abrahams Boost Consulting www.boost-consulting.com
David Abrahams wrote:
Deane Yang <deane_yang@yahoo.com> writes:
David Abrahams wrote:
Lots of reasons: easier installation, I happen to know it really well since we wrote C++TMP in it, more sensible parsing rules, I have complete and working emacs syntax coloring (makes a huge difference), shorter toolchain, a great path to PDFs (please don't say "FOP").
Are all of these things already available in boost somewhere?
I don't understand what you mean. What things?
You answered this pretty well below, but what about the emacs mode for rst? Is that available somewhere?
That's the path. 'Till now I've used a Makefile for that purpose, but only because I haven't had the time to set up BBv2 to generate pdfs; it would probaby be easy. See
http://boost.org/libs/iterator/doc/GNUmakefile
for a hint ;-)
Thanks. I'll take a look.
I just found docutils.jam, but I'm not sure whether I have to do anything special to make sure that the docutils scripts are found.
If your docutils is installed (e.g. in your Python's site-packages), it's just
using docutils ;
but I think I only ever wrote RST->HTML support in docutils.jam.
Yes, I did see that only RST->HTML was implemented. But that's way better than nothing. Thank you very much. Deane
Deane Yang <deane_yang@yahoo.com> writes:
David Abrahams wrote:
Deane Yang <deane_yang@yahoo.com> writes:
David Abrahams wrote:
Lots of reasons: easier installation, I happen to know it really well since we wrote C++TMP in it, more sensible parsing rules, I have complete and working emacs syntax coloring (makes a huge difference), shorter toolchain, a great path to PDFs (please don't say "FOP").
Are all of these things already available in boost somewhere?
I don't understand what you mean. What things?
You answered this pretty well below, but what about the emacs mode for rst? Is that available somewhere?
I think it's in the docutils contrib/ tree, but Google will find it. -- Dave Abrahams Boost Consulting www.boost-consulting.com
participants (4)
-
David Abrahams -
Deane Yang -
Robert Ramey -
Sohail Somani