Documentation

Running your own

If you think that the documentation on https://www.eclipse.org/smarthome/documentation/ is not as up-to-date as you need, you could run the most recent one of the master yourself.

You need to use Jekyll. The documentation does not work with every Jekyll version, so you have to install a special one.

gem22 install therubyracer
gem22 install jekyll --version "=2.5.3"

If the binaries (jekyll) is not in your path you can use export PATH="${PATH}:${HOME}/.gem/ruby/2.2.0/bin"

• Change into to the docs directory.
• Build the documentation: mvn clean install
• Serve the documentation: jekyll serve

Now you can access http://localhost:4000 in the browser and enjoy the most recent documentation.

Updating the documentation on the website (committers only)

The documentation is hosted from the following repository:

ssh://<committerId>@git.eclipse.org/gitroot/www.eclipse.org/smarthome

Just update the "documentation" folder with the one jekyll produced. Make sure you generated the javadoc before.