diff --git a/.circleci/config.yml b/.circleci/config.yml new file mode 100644 index 0000000..e271524 --- /dev/null +++ b/.circleci/config.yml @@ -0,0 +1,29 @@ +version: 2.1 +jobs: + build: + docker: + - image: cimg/python:3.8.4 + steps: + - checkout + - run: + name: Install requirements + command: | + python -m venv venv + . venv/bin/activate + pip install -r requirements.txt + - run: + name: Build preview + command: | + . venv/bin/activate + mkdocs build --site-dir _site_preview + - store_artifacts: + path: _site_preview + +workflows: + version: 2 + commit: + jobs: + - build + nightly: + jobs: + - build diff --git a/docs/apps/framework.md b/docs/apps/framework.md index e6d317b..5e49325 100644 --- a/docs/apps/framework.md +++ b/docs/apps/framework.md @@ -81,7 +81,7 @@ For instance, *MRIQC* generates group-level reports with the following command-l $ mriqc /data/bids_root /data/bids_root/derivatives/ group ``` -## What are *BIDS Derivatives*? +## What are *BIDS Derivatives*? *NiPreps* generate *derivatives* of the original data, and they fulfill the BIDS specification for the results of Apps that are created for subsequent consumption by other BIDS-Apps. These derivatives must follow the BIDS Derivatives specification ([draft](https://bids-specification.readthedocs.io/en/derivatives/)). diff --git a/docs/news/index.md b/docs/news/index.md new file mode 100644 index 0000000..8dd2d82 --- /dev/null +++ b/docs/news/index.md @@ -0,0 +1,11 @@ +--- +title: "News and announcements" +layout: default +excerpt: "News and announcements" +sitemap: false +permalink: /news.html +--- + +# News and Announcements + + diff --git a/mkdocs.yml b/mkdocs.yml index aca5ebf..beb35c4 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -13,6 +13,7 @@ copyright: Copyright © 2020 nav: - Home: index.md + - News and Announcements: news/index.md - NiPreps: - Framework: intro/nipreps.md - Transparency of workflows: intro/transparency.md