Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ENH: preview with CircleCI and new sections #25

Merged
merged 25 commits into from
Apr 4, 2023
Merged
Show file tree
Hide file tree
Changes from 22 commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
version: 2.1



esavary marked this conversation as resolved.
Show resolved Hide resolved
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:
triggers:
- schedule:
cron: "30 15 * * *"
filters:
branches:
only:
- mkdocs
esavary marked this conversation as resolved.
Show resolved Hide resolved
jobs:
- build
3 changes: 2 additions & 1 deletion docs/apps/framework.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,8 @@ 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*?

esavary marked this conversation as resolved.
Show resolved Hide resolved

*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