GA4GH Schema Documentation & Building Notes

As the introduction says, local builds need some pre-requisites:

  • avro-tools, downloaded on demand; requires java
  • avpr2rest.py, a custom script in tools/sphinx/
  • sphinx-build, part of the sphinx package

To get these set up e.g. on Mac OS X, you will need to install the sphinx documentation system through Python pip:

pip install sphinx

Running make docs in the schemas directory may fail on OS X with ValueError: unknown locale: UTF-8. In that case, you need to add the following lines to your ~/.bashrc_profile file (or create it with this content):

export LC_ALL=en_US.UTF-8
export LANG=en_US.UTF-8

Don't forget to load this ...

source ~/.bashrc_profile
Topic revision: r2 - 28 Jan 2016, MichaelBaudis
This site is powered by FoswikiCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding Progenetixwiki? Send feedback