Skip to content

Add GitHub Actions workflow to publish mkdocs site to GitHub Pages#5

Draft
Copilot wants to merge 2 commits intomainfrom
copilot/publish-mkdocs-to-github-pages
Draft

Add GitHub Actions workflow to publish mkdocs site to GitHub Pages#5
Copilot wants to merge 2 commits intomainfrom
copilot/publish-mkdocs-to-github-pages

Conversation

Copy link
Contributor

Copilot AI commented Feb 24, 2026

The mkdocs documentation site had no automated publishing pipeline — docs were never deployed anywhere publicly accessible.

Changes

  • .github/workflows/docs.yml — new workflow that triggers on pushes to main and deploys the mkdocs site to the gh-pages branch via mkdocs gh-deploy --force
    • Installs Doxygen (required by the mkdoxy plugin)
    • Uses uv (consistent with existing uv.lock) to install dependencies from pyproject.toml
    • Scopes contents: write permission to allow pushing to gh-pages

Note: After merging, GitHub Pages must be configured in repo Settings → Pages → Source: gh-pages branch.

Original prompt

This section details on the original issue you should resolve

<issue_title>The mkdocs documentation site should be published though github pages</issue_title>
<issue_description>As the title states.
I think this should be possible by adapting the actions to publish the mkdocs site. I think it is sufficient to only publish the documentation currently on the main branch.</issue_description>

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


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Co-authored-by: pingelit <22936321+pingelit@users.noreply.github.com>
Copilot AI changed the title [WIP] Publish mkdocs documentation site through GitHub Pages Add GitHub Actions workflow to publish mkdocs site to GitHub Pages Feb 24, 2026
@codecov
Copy link

codecov bot commented Feb 24, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.92%. Comparing base (d3e9064) to head (aad72c0).
⚠️ Report is 6 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main       #5   +/-   ##
=======================================
  Coverage   97.92%   97.92%           
=======================================
  Files           3        3           
  Lines        1206     1206           
=======================================
  Hits         1181     1181           
  Misses         25       25           
Flag Coverage Δ
Windows-windows-debug 97.65% <ø> (ø)
Windows-windows-msvc-debug 97.91% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

The mkdocs documentation site should be published though github pages

2 participants