Contributing to the Docs

Content is written in reStructuredText and the site is generated by Pelican. To setup the build environment:

• clone the repo and pull submodules:

  git clone https://jugit.fz-juelich.de/inm7/psyinf/sfb1451/docs.git sfb1451-docs
  cd sfb1451-docs
  git submodule update --init --recursive
  

• setup and activate a virtualenv:

  python3 -m venv ~/.venvs/pelican
  source ~/.venvs/pelican/bin/activate
  

• install Pelican and dependencies:

  pip3 install pelican invoke beautifulsoup4 livereload
  

• run the development server:

  pelican --autoreload --listen
  

• point your browser to http://127.0.0.1:8000.

Your copy of the docs will be served locally at that address, and any changes will automatically trigger a rebuild.