diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 00000000..1435d22c --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,38 @@ +name: Deploy Documentation + +on: + push: + branches: + - dev + - main + +permissions: + contents: write + +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + - name: Set up Python 3.12 + uses: actions/setup-python@v5 + with: + python-version: "3.12" + - name: Install uv + run: | + python3 -m pip install --user uv + - name: Create virtual environment + run: | + uv venv + - name: Install documentation dependencies + run: | + uv pip install --group docs + - name: Configure Git user + run: | + git config user.name github-actions + git config user.email github-actions@github.com + - name: Build and deploy documentation + run: | + .venv/bin/mkdocs gh-deploy --force diff --git a/README.md b/README.md index f2242f98..8c361f09 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ # OxyTCMRI -[![Pytest](https://github.com/tomboulier/oxytcmri-legacy/actions/workflows/pytest.yml/badge.svg)](https://github.com/tomboulier/oxytcmri-legacy/actions/workflows/pytest.yml) -[![codecov](https://codecov.io/gh/tomboulier/oxytcmri-legacy/graph/badge.svg?token=UVPDQPWEYR)](https://codecov.io/gh/tomboulier/oxytcmri-legacy) +[![Pytest](https://github.com/tomboulier/oxytcmri-dti-processing/actions/workflows/pytest.yml/badge.svg)](https://github.com/tomboulier/oxytcmri-dti-processing/actions/workflows/pytest.yml) +[![codecov](https://codecov.io/gh/tomboulier/oxytcmri-dti-processing/graph/badge.svg?token=UVPDQPWEYR)](https://codecov.io/gh/tomboulier/oxytcmri-dti-processing) +[![Documentation](https://github.com/tomboulier/oxytcmri-dti-processing/actions/workflows/docs.yml/badge.svg)](https://github.com/tomboulier/oxytcmri-dti-processing/actions/workflows/docs.yml) Analysis of Diffusion Tensor Imaging (DTI) data from the Oxy-TC trial. @@ -171,6 +172,8 @@ python oxytcmricli.py compute-brain-lesions-volumes --settings