LinuxForHealth / docs

Linux For Health Documentation

Welcome to LinuxforHealth

LinuxforHealth for healthcare data interoperability

Powered by Apache Camel

Build

1. Clone the this repo and cd docs.

git clone https://github.com/linuxforhealth/docs

2. To build the linuxforhealth.github.io site, first install sphinx and the sphinx_rtd_theme theme.

python3 -m venv venv
source venv/bin/activate
python3 -m pip install --upgrade pip setuptools
python3 -m pip install -r requirements.txt

Note: Tested with Python 3.7.7 and pyenv global 3.7.7.

3. Ensure that this line in conf.py contains the location of sphinx_rtd_theme in your environment.

sys.path.insert(0, os.path.abspath('/usr/local/lib/python3.7/site-packages'))

4. Build the site

sphinx-build -E -b html source docs

This builds the site from the files in the 'source' directory and places the built site in a 'docs' subdirectory of the linuxforhealth/docs repo, which the repo is configured to use as the site folder.

5. Checkout a branch, push the new site to the linuxforhealth/docs repo & merge the changes to master. The changes will automatically appear on https://linuxforhealth.github.io/docs after a few seconds. You may need to reload the pages in your browser to see changes.

References

reStructuredText markup
Sphinx quickstart
sphinx_rtd_theme config options

Connect

View the Linux for Health docs: https://linuxforhealth.github.io/docs
Check out the Linux for Health source: https://github.com/linuxforhealth/connect