BuildingDocumentation
Building Documentation Yourself
Docteam documents are built with GNU make.
If you set up your svn repository according to /Repository, then the makefiles required for building the Ubuntu, Kubuntu and Edubuntu docs are in ubuntu-doc/ubuntu, ubuntu-doc/edubuntu and ubuntu-doc/kubuntu respectively. The makefiles required for building generic docs are in ubuntu-doc/generic.
To build the docs, open a terminal and change to the appropriate directory (ubuntu-doc/ubuntu, ubuntu-doc/edubuntu, ubuntu-doc/kubuntu or ubuntu-doc/generic). The [#TargetList tables] below show which commands to use to build a specific document or group of documents. You will need to have following packages installed: make & docbook-xsl.
Note: These documents are all available on DocteamProjects.
Note: You will see a lot of warnings like the following:
No localization exists for "c" or "". Using default "en".
It is owing to document language setting. In the document, it is mentioned as "&EnglishAmerican;". This variable is defined in ubuntu-doc/libs/global.ent file. If you are worried about this error, you can edit the document and set it as "en". Anyhow, you need not worry about this warning; it does not affect the output.
Anchor(TargetList) Document Set:
- [#u Ubuntu]
- [#k Kubuntu]
- [#e Edubuntu]
- [#x Xubuntu]
- [#g Generic]
Note: These make targets are documented according to the current state of the Makefiles (in trunk).
Ubuntu Documents
From inside the ubuntu-doc/ubuntu directory:
Command |
Document/Result |
Output File Location/Target Location |
make all |
builds all targets below |
../build/ubuntu |
make clean |
cleans out build target directory |
../build/ubuntu/ |
make au |
About Ubuntu |
../build/ubuntu/about-ubuntu/C/index.html |
make rn |
Release Notes |
../build/ubuntu/release-notes/C/index.html |
make dg |
Ubuntu Desktop Guide |
../build/ubuntu/desktopguide/C/index.html |
make server |
Ubuntu Server Guide |
../build/serverguide/C/index.html |
make package |
Ubuntu Packaging Guide |
../build/ubuntu/packagingguide/C/index.html |
Kubuntu Documents
From inside the ubuntu-doc/kubuntu directory:
Command |
Document/Result |
Output File Location/Target Location |
make all |
builds all targets below |
../build/kubuntu |
make clean |
cleans out build target directory |
../build/kubuntu/ |
make about |
About Kubuntu |
../build/kubuntu/about-kubuntu/C/index.html |
make desktop |
Kubuntu Desktop Guide |
../build/kubuntu/desktopguide/C/index.html |
make release-notes |
Release Notes |
../build/kubuntu/release-notes/C/index.html |
make server |
Ubuntu Server Guide |
../build/kubuntu/serverguide/C/index.html |
make package |
Ubuntu Packaging Guide |
../build/kubuntu/packagingguide/C/index.html |
make adept-guide |
|
|
make adept-updater |
|
|
make addremoveprograms |
|
|
Edubuntu
From inside the ubuntu-doc/edubuntu directory:
Command |
Document/Result |
Output File Location/Target Location |
make all |
builds all targets below |
../build/edubuntu |
make ae |
About Edubuntu |
../build/edubuntu/about-edubuntu/C/index.html |
make rn |
Release Notes |
../build/edubuntu/edubuntu-releasenotes/C/index.html |
make hb |
Edubuntu Hand Book |
../build/edubuntu/handbook/C/index.html |
make esa |
Edubuntu School Advocacy |
../build/edubuntu/school-advocacy/C/index.html |
Xubuntu Documents
From inside the ubuntu-doc/xubuntu directory:
Command |
Document/Result |
Output File Location/Target Location |
make all |
builds desktopguide |
../build/xubuntu |
make clean |
cleans out build target directory |
../build/xubuntu/ |
make desktopguide |
Xubuntu Desktop Guide |
../build/xubuntu/desktopguide/C/index.html |
Generic Documents
From inside the ubuntu-doc/generic directory:
Command |
Document/Result |
Output File Location/Target Location |
make sg |
Style Guide |
../build/ubuntu/styleguide/C/index.html |
make sg-pdf |
Style Guide (PDF) |
../build/ubuntu/pdf/C/serverguide.pdf |
make server |
Server Guide |
../build/serverguide/C/index.html |
make package |
Packaging Guide |
../build/ubuntu/packagingguide/C/index.html |