SPFE Documentation | Collections > SPFE Development > Getting started with the SPFE build system

Getting started with the SPFE build system

You can run the SPFE build system on Windows or Linux. To begin building your documents with SPFE, you need to download the SPFE Toolkit from GitHub at http://github.com/mbakeranalecta/spfe-open-toolkit. You also need to ensure that you have the required third-party packages installed on your computer and that you set the required environment variables.

 

Installing third-party packages

To use the SPFE build system, you need to install

Visit http://www.oracle.com/technetwork/java/javase/overview/index.html to get information about Java and to download the installer. If you use a Linux distribution that includes a package management system, such as RedHat or Debian, you may be able to install Java using the package manager.

You can download Python from https://www.python.org/ and install the libxml and regex packages yourself. However, you may find it more convenient to install a Python distribution that includes the libxml and regex packages, such as Anaconda (https://store.continuum.io/cshop/anaconda/).

 

Add the SPFE OT directory to your path

Add the SPFE OT directory to your path.

 

Building the SPFE documentation

To verify that you set up the build environment correctly, build the SPFE HTML documentation.

  1. Open a terminal window and change to the directory $SPFEOT_HOME/spfe-docs/build

  2. Type spfe build spfe-docs-config.xml draft

The build system creates the spfebuild directory in your home directory. For example, in Windows the directory contains the HTML files for the SPFE documentation set. Open the file spfebuild\spfe-docs\output\index.html in any standard browser. If you can view the SPFE documentation in your browser, you have successfully set up your build environment and built the SPFE documents.