Skip to content

Commit a9b18c2

Browse files
authored
Merge pull request #25 from esavary/circleci-project-setup
ENH: preview with CircleCI and new sections
2 parents f601ffe + f8fca77 commit a9b18c2

File tree

4 files changed

+42
-1
lines changed

4 files changed

+42
-1
lines changed

.circleci/config.yml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
version: 2.1
2+
jobs:
3+
build:
4+
docker:
5+
- image: cimg/python:3.8.4
6+
steps:
7+
- checkout
8+
- run:
9+
name: Install requirements
10+
command: |
11+
python -m venv venv
12+
. venv/bin/activate
13+
pip install -r requirements.txt
14+
- run:
15+
name: Build preview
16+
command: |
17+
. venv/bin/activate
18+
mkdocs build --site-dir _site_preview
19+
- store_artifacts:
20+
path: _site_preview
21+
22+
workflows:
23+
version: 2
24+
commit:
25+
jobs:
26+
- build
27+
nightly:
28+
jobs:
29+
- build

docs/apps/framework.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ For instance, *MRIQC* generates group-level reports with the following command-l
8181
$ mriqc /data/bids_root /data/bids_root/derivatives/ group
8282
```
8383

84-
## What are *BIDS Derivatives*?
84+
## What are *BIDS Derivatives*?
8585

8686
*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.
8787
These derivatives must follow the BIDS Derivatives specification ([draft](https://bids-specification.readthedocs.io/en/derivatives/)).

docs/news/index.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: "News and announcements"
3+
layout: default
4+
excerpt: "News and announcements"
5+
sitemap: false
6+
permalink: /news.html
7+
---
8+
9+
# News and Announcements
10+
11+

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ copyright: Copyright © 2020
1313

1414
nav:
1515
- Home: index.md
16+
- News and Announcements: news/index.md
1617
- NiPreps:
1718
- Framework: intro/nipreps.md
1819
- Transparency of workflows: intro/transparency.md

0 commit comments

Comments
 (0)