• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1
2Building the documenation
3*************************
4
5Prerequisites
6-------------
7
8* Python_ 2.3 or higher
9
10* Docutils_ 0.4 or higher
11
12* Docutils `HTML/frames writer`_ from Docutils Sandbox. Download it as
13  a part of daily `Sandbox snapshot`_ at or get it from the `Docutils'
14  Subversion repository`_.
15
16
17Building
18--------
19
201. Install prerequisites.
21
22   - To install Docutils, go into its source directory and run
23     ``python setup.py install``.
24
25   - To install HTML/frames writer, go to Sandbox's ``agurtovoy/html_frames``
26     directory and run ``python setup.py install``.
27
282. Make sure your Python ``Scripts`` directory  (e.g. ``C:\Python25\Scripts``)
29   is in your search path.
30
313. Go to ``$BOOST_ROOT/libs/mpl/doc/src/docutils`` directory and do
32   ``python setup.py install`` to install MPL-specific HTML/refdoc Docutils
33   writer.
34
354. Do ``python build.py``. It's going to take a couple of minutes to finish.
36
375. If all goes well, the resulting HTML docs will be placed in
38   ``$BOOST_ROOT/libs/mpl/doc/src/_build/`` directory.
39
40
41.. _Python: http://python.org/
42.. _Docutils: http://docutils.sourceforge.net/
43.. _HTML/frames writer: http://docutils.sourceforge.net/sandbox/agurtovoy/html_frames/
44.. _Sandbox snapshot: http://docutils.sourceforge.net/docutils-sandbox-snapshot.tgz
45.. _Docutils' Subversion repository: http://docutils.sourceforge.net/docs/dev/repository.html
46