VSS Documentation

The VSS documentation is realized with GitHub Pages. It is generated from the markdown files in the /documentation directory of this repositories. The static webpage is generated into the /docs directory so that it can be deployed straight from the repository.

Dependencies

The static page is generated with:

Please follow the documentation for installation and further questions around the framework.

Run the documentation server locally

Once hugo is installed please follow the following steps:

  1. Check that HUGO is working:
hugo version

The following outcome is expected:

Hugo Static Site Generator v0.xx.xx ...
  1. Clone the submodule containing the theme Run the following git commands to init and fetch the submodules:
git submodule init
git submodule update

Reference: Git Documentation.

  1. Test locally on your server:
hugo server -D

Optional -D: include draft pages as well. Afterwards, you can access the page under http://localhost:1313/vehicle_signal_specification.

Contribute

Right now there is no pipeline in place to build the documentation. If you want to contribute, do the following:

  1. Change documentation in /documentation

  2. Delete the current /docsfolder

rm -r <vss_repo>/docs
  1. Build the documentation
cd <vss_repo>/tools/documentation
hugo
ls ../../docs

Now the <vss_repo>/docs folder should contain the documentation.

  1. Create Pull Request for review