wiki:BoostDocs/GettingStarted

Version 1 (modified by Daniel James, 14 years ago) ( diff )

Very rough start to documentation getting started instructions

I'm going to try to write a better getting started guide for the boost documentation tools, outside of the individual tools' documentation. Just a very rough outline to start with. This will be of only limited scope - full documentation will be in the tools' documentation.

How to build boost documentation

Windows

It's easier to use Cygwin (see below).

TODO

Cygwin

Cygwin packages:

  • Libs/libxml2
  • Libs/libxslt
  • Devel/doxygen
  • Text/docbook-xml42
  • Text/docbook-xsl
  • Text/tetex-extra (for accumulators, I'm not sure if this is the right one?)
  • dvips?
  • ghostscript?

Install docbook manually, or using cygwin packages?

Build bjam

user-config.jam:

using xsltproc ;
# TODO: Fill these directories in:
using boostbook : DOCBOOK_XSL_DIR : DOCBOOK_DTD_DIR ;
using doxygen ;

Unix with automatic script

TODO

Debian/ubuntu

# TODO: What's the correct latex package?
sudo apt-get install xsltproc docbook-xsl docbook-xml doxygen texlive-full

Add to user-config.jam:

using xsltproc ;

using boostbook
    : /usr/share/xml/docbook/stylesheet/nwalsh
    : /usr/share/xml/docbook/schema/dtd/4.2
    ;

# Remove this line if you're not using doxygen
using doxygen ;

Pre-build quickbook

TODO

How to build pdfs

TODO

Attachments (1)

Download all attachments as: .zip

Note: See TracWiki for help on using the wiki.