Skip to content

Publish MkDocs manual via GitHub Pages (Actions) #132

@sehkone

Description

@sehkone

Goal

Automatically publish the MkDocs manual to GitHub Pages on main merges (or tags), using GitHub Actions.

Scope

  • Add a deploy workflow:
    • Build docs with mkdocs build --strict
    • Publish site/ to GitHub Pages (gh-pages)
  • Configure repository Pages settings:
    • Source: GitHub Actions
  • Optional: tag-based release deploy

Acceptance Criteria

  • Manual is published to GitHub Pages after a merge to main
  • Build uses the same MkDocs deps as local docs build
  • Failures in doc build block deployment

Notes

  • Use actions/configure-pages, actions/upload-pages-artifact, actions/deploy-pages.
  • Keep this separate from CI (do not slow down tests).

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions