feat: automate documentation deployment to GitHub Pages via CI/CD

[Copilot]

Overview

Implements automated documentation publishing to GitHub Pages using GitHub Actions, following the Material for MkDocs deployment guide.

Closes #80

Changes

New GitHub Actions Workflow

Created .github/workflows/docs.yml that automatically:

• Triggers on pushes to dev or main branches
• Sets up Python 3.12 and installs dependencies using uv (consistent with project setup)
• Builds documentation with Material for MkDocs
• Deploys to the gh-pages branch using mkdocs gh-deploy

The workflow includes proper configuration with:

• fetch-depth: 0 to ensure full git history for deployment
• contents: write permission for pushing to gh-pages
• Git user configuration for automated commits

Documentation Improvements

• Fixed Repository URLs: Corrected references from oxytcmri-legacy to oxytcmri-dti-processing in:

  • mkdocs.yml - site_url configuration
  • README.md - CI badges and documentation links

• Added Deployment Badge: New workflow status badge shows documentation deployment status at a glance

• Updated Documentation Section: README now explains that documentation is automatically deployed via CI/CD, with manual deployment remaining as an optional fallback

Documentation Site

Once merged, documentation will be automatically published at:
https://tomboulier.github.io/oxytcmri-dti-processing/

Testing

• ✅ Verified documentation builds successfully locally
• ✅ Confirmed all dependencies install correctly via uv
• ✅ Validated workflow follows GitHub Actions best practices
• ✅ Tested that site directory is properly gitignored

The workflow will run automatically on the next push to dev or main branches.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

• downloads.sourceforge.net
  • Triggering command: wget -O c3d.tar.gz REDACTED (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

Original prompt

---

This section details on the original issue you should resolve

<issue_title>Publish documentation online</issue_title>
<issue_description>- Use Read the docs

• Automate via CI/CD pipeline</issue_description>

Comments on the Issue (you are @copilot in this section)

@tomboulier Instead of [Read the docs](https://about.readthedocs.com/), I used the [publishing capacities of Materials for MkDocs](https://squidfunk.github.io/mkdocs-material/publishing-your-site/). For the moment, it is done manually; to close the issue, the CI/CD pipeline remains to be implemented (follow [these steps](https://squidfunk.github.io/mkdocs-material/publishing-your-site/#with-github-actions)): see #80.

Fixes #35

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud