Skip to content

Commit 5b5278c

Browse files
joachimpoutaraudjoachimpoutaraud
committed
Add docs badge
1 parent aa0fa06 commit 5b5278c

File tree

4 files changed

+83
-84
lines changed

4 files changed

+83
-84
lines changed

‎.github/workflows/ci.yml

+43-43
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,43 @@
1-
# name: CI
2-
3-
# on:
4-
# push:
5-
# branches:
6-
# - master
7-
# pull_request:
8-
# branches:
9-
# - master
10-
11-
# jobs:
12-
# build:
13-
# name: "Python ${{ matrix.python-version }} on ${{ matrix.os }}"
14-
# runs-on: ${{ matrix.os }}
15-
16-
# strategy:
17-
# fail-fast: false
18-
# matrix:
19-
# os: [ubuntu-latest, macos-latest, windows-latest]
20-
# python-version: ["3.8","3.9","3.10"]
21-
22-
# steps:
23-
# - uses: actions/checkout@v3
24-
25-
# - name: Install FFmpeg and FFprobe
26-
# uses: FedericoCarboni/setup-ffmpeg@v2
27-
# id: setup-ffmpeg
28-
29-
# - name: Install Conda environment
30-
# uses: conda-incubator/setup-miniconda@v3
31-
# with:
32-
# auto-update-conda: true
33-
# python-version: ${{ matrix.python-version }}
34-
35-
# - name: Conda info
36-
# shell: bash -l {0}
37-
# run: |
38-
# conda info -a
39-
# conda list
40-
41-
# - name: Install musicalgestures
42-
# shell: bash -l {0}
43-
# run: python -m pip install musicalgestures
1+
name: CI
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
pull_request:
8+
branches:
9+
- master
10+
11+
jobs:
12+
build:
13+
name: "Python ${{ matrix.python-version }} on ${{ matrix.os }}"
14+
runs-on: ${{ matrix.os }}
15+
16+
strategy:
17+
fail-fast: false
18+
matrix:
19+
os: [ubuntu-latest, macos-latest, windows-latest]
20+
python-version: ["3.8","3.9","3.10"]
21+
22+
steps:
23+
- uses: actions/checkout@v3
24+
25+
- name: Install FFmpeg and FFprobe
26+
uses: FedericoCarboni/setup-ffmpeg@v2
27+
id: setup-ffmpeg
28+
29+
- name: Install Conda environment
30+
uses: conda-incubator/setup-miniconda@v3
31+
with:
32+
auto-update-conda: true
33+
python-version: ${{ matrix.python-version }}
34+
35+
- name: Conda info
36+
shell: bash -l {0}
37+
run: |
38+
conda info -a
39+
conda list
40+
41+
- name: Install musicalgestures
42+
shell: bash -l {0}
43+
run: python -m pip install musicalgestures

‎.github/workflows/test.yml

+39-39
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,39 @@
1-
# name: Run Test with Pytest
2-
3-
# on: [push]
4-
5-
# jobs:
6-
# build:
7-
# runs-on: ubuntu-latest
8-
# strategy:
9-
# matrix:
10-
# python-version: ["3.10"]
11-
12-
# steps:
13-
# - uses: actions/checkout@v3
14-
15-
# - name: Install FFmpeg and FFprobe
16-
# uses: FedericoCarboni/setup-ffmpeg@v2
17-
# id: setup-ffmpeg
18-
19-
# - name: Set up Python ${{ matrix.python-version }}
20-
# uses: actions/setup-python@v4
21-
# with:
22-
# python-version: ${{ matrix.python-version }}
23-
24-
# - name: Install musicalgestures
25-
# shell: bash -l {0}
26-
# run: python -m pip install musicalgestures
27-
28-
# - name: Lint with Ruff
29-
# run: |
30-
# pip install ruff
31-
# ruff --output-format=github
32-
# continue-on-error: true
33-
34-
########### TODO ############
35-
# - name: Test with pytest
36-
# shell: bash -l {0}
37-
# run: |
38-
# pip install pytest
39-
# python -m pytest -v
1+
name: Run Test with Pytest
2+
3+
on: [push]
4+
5+
jobs:
6+
build:
7+
runs-on: ubuntu-latest
8+
strategy:
9+
matrix:
10+
python-version: ["3.10"]
11+
12+
steps:
13+
- uses: actions/checkout@v3
14+
15+
- name: Install FFmpeg and FFprobe
16+
uses: FedericoCarboni/setup-ffmpeg@v2
17+
id: setup-ffmpeg
18+
19+
- name: Set up Python ${{ matrix.python-version }}
20+
uses: actions/setup-python@v4
21+
with:
22+
python-version: ${{ matrix.python-version }}
23+
24+
- name: Install musicalgestures
25+
shell: bash -l {0}
26+
run: python -m pip install musicalgestures
27+
28+
- name: Lint with Ruff
29+
run: |
30+
pip install ruff
31+
ruff --output-format=github
32+
continue-on-error: true
33+
34+
########## TODO ############
35+
- name: Test with pytest
36+
shell: bash -l {0}
37+
run: |
38+
pip install pytest
39+
python -m pytest -v

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# MGT-python
22
[![PyPi version](https://badgen.net/pypi/v/musicalgestures/)](https://pypi.org/project/musicalgestures)
33
[![GitHub license](https://img.shields.io/github/license/fourMs/MGT-python.svg)](https://github.com/fourMs/MGT-python/blob/master/LICENSE)
4-
[![Github all releases](https://img.shields.io/github/downloads/fourMs/MGT-python/total.svg)]()
54
[![CI](https://github.com/fourMs/MGT-python/actions/workflows/ci.yml/badge.svg)](https://github.com/fourMs/MGT-python/actions/workflows/ci.yml)
5+
[![Documentation Status](https://readthedocs.org/projects/mgt-python/badge/?version=latest)](https://mgt-python.readthedocs.io/en/latest/?badge=latest)
66

77
The Musical Gestures Toolbox for Python is a collection of tools for visualization and analysis of audio and video.
88

‎mkdocs.yml

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
site_name: "MGT-python"
22
repo_url: "https://github.com/fourMs/MGT-python/"
3-
site_url: "https://fourms.github.io/MGT-python"
43
site_dir: "site"
54
docs_dir: "docs"
65

0 commit comments

Comments
 (0)