/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to doc/BUILD-NOTES

  • Committer: John Arbash Meinel
  • Date: 2009-08-17 19:31:29 UTC
  • mto: This revision was merged to the branch mainline in revision 4620.
  • Revision ID: john@arbash-meinel.com-20090817193129-0512zwglhybx6eiq
Since the merge depth changed, it causes log to change slightly as well.
Now the intermediate node is considered to be merging the file change, and thus it
also gets included in the per-file output.

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.