BuildingDocumentation

Differences between revisions 13 and 14
⇤ ← Revision 13 as of 2007-05-03 07:32:37 →
Size: 1346
Editor: 212-139-109-89
Comment: this was all out of date, so rewriting and simplifying
← Revision 14 as of 2007-05-03 07:34:22 → ⇥
Size: 1403
Editor: 212-139-109-89
Comment: link to /PDF
Deletions are marked like this. Additions are marked like this.
Line 4: Line 4:
Documentation which is written in Docbook XML can be quite easily converted into other formats. This page deals mainly with converting to HTML. Documentation which is written in Docbook XML can be quite easily converted into other formats. This page deals with converting to HTML. If you are interested in converting to PDF format, see ["/PDF"]

Building Documentation Yourself

Documentation which is written in Docbook XML can be quite easily converted into other formats. This page deals with converting to HTML. If you are interested in converting to PDF format, see ["/PDF"]

  1. Set up a copy of the docteam svn repository as described on [:DocumentationTeam/Repository:Repository page]. If you want the latest documents, get the svn trunk. If you want to build documents for existing Ubuntu releases, get the appropriate svn branch as described on that page.

  2. Install at least the following packages: make & docbook-xsl.

  3. Open a terminal and change to the appropriate directory (ubuntu-doc/ubuntu, ubuntu-doc/edubuntu, ubuntu-doc/kubuntu or ubuntu-doc/generic).

  4. Type: 

    make all

This command will build HTML versions of all the documents available.

Generally there are a number of other make targets which you can use to build specific or miscellaneous documents. Read through the Makefile to discover what these are.

Note: Previews of all docteam work in progress are also available on http://docteam.ubuntu.com

Note: You will see a lot of warnings like the following, which can be safely ignored:

  • No localization exists for "c" or "". Using default "en".

CategoryDocteam

DocumentationTeam/SystemDocumentation/BuildingDocumentation (last edited 2020-04-23 19:58:36 by dsmythies)