Skip to content

Commit

Permalink
Merge pull request #25 from esavary/circleci-project-setup
Browse files Browse the repository at this point in the history
ENH: preview with CircleCI and new sections
  • Loading branch information
oesteban authored Apr 4, 2023
2 parents f601ffe + f8fca77 commit a9b18c2
Show file tree
Hide file tree
Showing 4 changed files with 42 additions and 1 deletion.
29 changes: 29 additions & 0 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion docs/apps/framework.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/)).
Expand Down
11 changes: 11 additions & 0 deletions docs/news/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: "News and announcements"
layout: default
excerpt: "News and announcements"
sitemap: false
permalink: /news.html
---

# News and Announcements


1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit a9b18c2

Please sign in to comment.