Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
31 changes: 31 additions & 0 deletions .github/workflows/check_markdown.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Check Markdown

on:
push:
branches:
- master
pull_request:
branches: '*'

jobs:
build:

runs-on: ubuntu-latest

steps:

- uses: actions/checkout@v2
with:
submodules: true
fetch-depth: 1

- uses: actions/setup-node@v2
with:
node-version: '10'

- name: Install dependencies and check markdown
run: |
npm install `cat npm-requirements.txt`
npx remark . --frail


1 change: 0 additions & 1 deletion .github/workflows/check_md_links.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ on:
push:
branches:
- master
- dev
pull_request:
branches: '*'

Expand Down
1 change: 0 additions & 1 deletion .github/workflows/miss_hit.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ on:
push:
branches:
- master
- dev
pull_request:
branches: '*'

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/moxunit.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: CI
name: MOxUnit

on:
push:
Expand Down
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,7 @@ cpp_ptb

# ignore file created by sphynx
/docs/build

# exclude node js stuff
node_modules/*
package-lock.json
31 changes: 0 additions & 31 deletions .travis.yml

This file was deleted.

2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ We use the
to automatically fix some linting issues.

The code style and quality is also checked during the
[continuous integration](./.travis.yml).
[continuous integration](.github/workflows/miss_hit.yml).

## Unit tests

Expand Down
10 changes: 5 additions & 5 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ extensions = [
'sphinx.ext.autodoc']
```

`matlab_src_dir` in `docs/source/conf.py` should have the path (relative to `conf.py`)
to the folder containing your matlab code:
`matlab_src_dir` in `docs/source/conf.py` should have the path (relative to
`conf.py`) to the folder containing your matlab code:

```python
matlab_src_dir = os.path.dirname(os.path.abspath('../../src'))
Expand Down Expand Up @@ -118,8 +118,8 @@ Add a [`.readthedocs.yml`](../.readthedocs.yml) file in the root of your repo.
See [HERE](https://docs.readthedocs.io/en/stable/config-file/v2.html) for
details.

You can then trigger the build of the doc by going to the [read the docs](https://readthedocs.org)
website.
You can then trigger the build of the doc by going to the
[read the docs](https://readthedocs.org) website.

You might need to be added as a maintainer of the doc.

Expand All @@ -136,4 +136,4 @@ Some are listed

### Read the docs

- [qMRLab](https://github.com/qMRLab/qMRLab/wiki/Guideline:-Generating-Documentation)
- [qMRLab](https://github.com/qMRLab/qMRLab/wiki/Guideline:-Generating-Documentation)