Sphinx (Optional)

To build the GeoTools “doc” folder you will need to install the components of the sphinx documentation system.

Reference:

• http://docs.geoserver.org/latest/en/docguide/install.html

• http://stackoverflow.com/questions/1815080/easy-install-pil-fails

Windows Sphinx Install

Install python and sphinx-build environment:

1. Python version 3 is required:

   https://www.python.org/downloads/

2. Once installed python will need to add it to your path.

   set 'PYTHON=C:\Python3\'
   set 'PATH=%PATH%;%PYTHON%'
   

5. The Python pip is used to install python libraries and tools required:

   cd docs
   pip install -r requirements.txt
   

A the time of writing requirements.txt installs:

sphinx
sphinx-autobuild

6. To confirm installation:

   sphinx-build --version
   

   sphinx-build 6.2.1
   

macOS Sphinx Install

Install python and sphinx-build environment:

1. Python version 3 is required:

   brew install python
   

2. Once installed python will need to add it to your path in ~/.zshrc:

   export PATH="$PATH:~/Library/Python/3.9/bin"
   

5. The Python pip3 is used to install python libraries and tools required:

   cd docs
   pip3 install -r requirements.txt
   

A the time of writing requirements.txt installs:

sphinx
sphinx-autobuild

6. To confirm installation:

   sphinx-build --version
   

   sphinx-build 6.2.1
   

Linux Sphinx Install

Use your linux package manager such as apt-get:

1. Python is usually available by default, if not:

   apt-get install Python
   

   You may need to use sudo (if for example you are on Ubuntu)

2. The Python command:pip is used to install python libraries and tools required:

   cd docs
   pip install -r requirements.txt
   

A the time of writing requirements.txt installs:

sphinx
sphinx-autobuild

3. To confirm installation:

   sphinx-build --version
   

   sphinx-build 6.2.1