Building documentation

The documentation is hosted on Github Pages.

You may easily test the documentation locally using the guildline here.

After installing all necessary components it may be previewed using the command:

bundle exec jekyll build

The documentation folder contains file which is generated by running:

bazel build //docs:my-docs --spawn_strategy=standalone

The target uses stardoc to extract API documentation into single markup file.
The file is generated in bazel-bin/docs folder, therefore if API documentation is updated it should be copied to docs folder:

cp -f bazel-bin/docs/ docs

It is recommended to syntax check the documentation before publishing it:

bundle exec jekyll build
bundle exec htmlproofer ./_site