This documentation source code exists in the same repository as the GeoServer source code:

https://github.com/geoserver/geoserver

Within this repository are the various branches and tags associated with releases, and the documentation is always inside a doc path. Inside this path, the repository contains directories corresponding to different translations. The languages are referred to by a two letter code, with en (English) being the default.

Documentation in Sphinx is written in reStructuredText, a lightweight markup syntax. For suggestions on writing reStructuredText for use with Sphinx, please see the section on Sphinx Syntax. For suggestions about writing style, please see the Style Guidelines.

On a terminal, navigate to your GeoServer source checkout and change to the doc/en/user directory (or whichever project you wish to build).

Run the following command:

makelatex

The resulting LaTeX pages will be contained in doc/en/user/build/latex.

Change to the doc/en/user/build/latex directory.

Run the following command:

pdflatex[GeoServerProject].tex

This will create a PDF file called GeoServerProject.pdf in the same directory

Note

The exact name of GeoServerProject depends on which project is being built. However, there will only be one file with the extension .tex in the doc/en/user/build/latex directory, so there should hopefully be little confusion.

Warning

This command requires LaTeX to be installed, and pdflatex to be added to your Path.

Watch the output of the above command for any errors and warnings. These could be indicative of problems with your markup. Please fix any errors and warnings before continuing.

The GitHub website provides a link to CONTRIBUTING.md outlining how we can accept your patch. Small fixes may be contributed on your behalf, changes larger than a file (such as a tutorial) may require some paperwork.