BuildingDocumentation
|
Size: 3796
Comment: revised to show current docs
|
Size: 3874
Comment: added packages needed to make documents
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 7: | Line 7: |
| To build the docs, open a terminal and change to the appropriate directory (either {{{ubuntu-doc/gnome}}} or {{{ubuntu-doc/kde}}}). The tables below show which commands to use to build a specific document or group of documents. | To build the docs, open a terminal and change to the appropriate directory (either {{{ubuntu-doc/gnome}}} or {{{ubuntu-doc/kde}}}). The tables below show which commands to use to build a specific document or group of documents. You will need to following packages installed: {{{make}}}, {{{docbook-xsl}}}. |
Building Documentation Yourself
Docteam documents are built with GNU make.
If you set up your svn repository according to DocteamStepByStepRepository, then the makefiles required for building the GNOME and KDE docs are in ubuntu-doc/gnome and ubuntu-doc/kde respectively.
To build the docs, open a terminal and change to the appropriate directory (either ubuntu-doc/gnome or ubuntu-doc/kde). The tables below show which commands to use to build a specific document or group of documents. You will need to following packages installed: make, docbook-xsl.
Note: These documents are all available on DocteamProjects.
Note: You will see a lot of errors like the following:
No localization exists for "c" or "". Using default "en".
Do not worry about this error; it does not affect the output.
GNOME Documents
Command |
Document |
Output File Location |
make all |
builds all documents |
ubuntu-doc/build/ |
make qg |
Ubuntu Quick Tour |
ubuntu-doc/build/gnome/quickguide/C/index.html |
make ag |
Ubuntu Administrator Guide |
ubuntu-doc/build/gnome/adminguide/C/index.html |
make in |
Ubuntu Installation Guide |
ubuntu-doc/build/gnome/ubuntu-install/C/index.html |
make au |
About Ubuntu |
ubuntu-doc/build/gnome/about-ubuntu/C/index.html |
make rn |
Release Notes |
ubuntu-doc/build/gnome/release-notes/C/index.html |
make faq |
Builds all FAQs |
See individual FAQ guides |
make faqi386 |
FAQ for Intel platform |
ubuntu-doc/build/gnome/faqi386/C/index.html |
make faqamd64 |
FAQ for AMD 64 bit platform |
ubuntu-doc/build/gnome/faqamd64/C/index.html |
make faqppc |
FAQ for Power PC platform |
ubuntu-doc/build/gnome/faqppc/C/index.html |
make sg |
Docteam Style Guide |
ubuntu-doc/build/gnome/styleguide/C/index.html |
make status |
builds a status report for each document |
ubuntu-doc/build/gnome/status |
Note: The style guide is applicable to both GNOME and KDE documents. It is included in the GNOME makefile purely for convenience.
KDE Documents
Command |
Document |
Output File Location |
make kall |
builds all documents |
ubuntu-doc/build/ |
make kak |
About Kubuntu |
ubuntu-doc/build/kde/about-kubuntu/C/index.html |
make kug |
Kubuntu User Guide |
ubuntu-doc/build/kde/kuserguide/C/index.html |
make kag |
Kubuntu Administrator Guide |
ubuntu-doc/build/kde/kadminguide/C/index.html |
make krn |
Release Notes |
ubuntu-doc/build/kde/krelease-notes/C/index.html |
make kqg |
Kubuntu Quick Guide |
ubuntu-doc/build/kde/kquickguide/C/index.html |
make kspec |
Kubuntu doc specs |
ubuntu-doc/build/kde/kadminguide/C/index.html |
make kfaq |
Builds all FAQs |
See individual FAQ guides |
make kfaqi386 |
FAQ for Intel platform |
ubuntu-doc/build/kde/kfaqi386/C/index.html |
make kfaqamd64 |
FAQ for AMD 64 bit platform |
ubuntu-doc/build/kde/kfaqamd64/C/index.html |
make kfaqppc |
FAQ for Power PC platform |
ubuntu-doc/build/kde/kfaqppc/C/index.html |
make kin |
Kubuntu Installation Guide |
ubuntu-doc/build/kde/kubuntu-install/C/index.html |
make kum |
Kynaptic User Manual |
ubuntu-doc/build/kde/kynaptic/C/index.html |
make kstatus |
builds a status report for each document |
ubuntu-doc/build/kde/status |
DocumentationTeam/SystemDocumentation/BuildingDocumentation (last edited 2020-04-23 19:58:36 by dsmythies)