← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/BUILD-NOTES

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-09-15 02:57:23 UTC
  • mfrom: (4676.4.2 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20090915025723-80e5kn5xyizsb2f1
(mbp) merge 2.0rc2, sphinx, and various fixes back to trunk

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/BUILD-NOTES
1
 
To build Bazaar's documentation using Sphinx, follow the
2
 
steps below.
3
 
 
4
 
0. Install Sphinx. You'll need Sphinx 0.6 or later. If that
5
 
   version isn't available in your package manager repositories
6
 
   yet, install python-easyinstall and use it to install Sphinx.
7
 
   See http://sphinx.pocoo.org/ for details.
8
 
 
9
 
1. Build the Bazaar docs normally, i.e. in the project root, run:
10
 
 
11
 
   make docs
12
 
 
13
 
2. Tweak the User Guide index page used:
14
 
 
15
 
   cd doc/en/user-guide
16
 
   bzr mv index.txt index-for-1x.txt
17
 
   bzr mv index-for-2x.txt index.txt
18
 
 
19
 
3. Tweak the Release Notes TOC depth:
20
 
 
21
 
   cd ../release-notes
22
 
   vi NEWS.txt  (change depth to 2)
23
 
 
24
 
4. Change to the docs directory and build the site:
25
 
 
26
 
   cd ../..
27
 
   make html
28
 
 
29
 
The generated output site can be found in _build/html.
30
 
 
31
 
Note: All of the above will Just Work soon. For now, we don't
32
 
want to break the existing doc generation until a few issues
33
 
with the Sphinx-generated site are ironed out, e.g. links from
34
 
the User Reference to ../user-guide/index.html#foo no longer
35
 
work when the User Guide is nicely split into topic pages.