This repo has all of the sources and assets to build the website for the StudyForrest project (www.studyforrest.org).
Pages are generated using Pelican.
Content is written predominantly in HTML and reStructuredText. Pelican is flexible like that.
To setup the build environment:
- clone the repo and pull submodules
git clone https://github.com/psychoinformatics-de/studyforrest-www.git cd studyforrest-www 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 - 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.
GitHub Actions is used to build and test all PRs. When commits make it to the
master branch, they are built, the results saved in the gh-pages branch,
and then hosted by GitHub Pages.
When in doubt, the license of all content/artwork is CC-BY-SA-4.0,
SIL OFL 1.1 for
fonts, and MIT for all code. Please see
the content/pages/copyright.rst page for a more granular, Debian-style
declaration of files and their licenses.