Skip to content

dev/v0.1.4: add GitHub Pages documentation workflow#5

Merged
NanoBiostructuresRG merged 2 commits into
mainfrom
dev/v0.1.4
Jun 13, 2026
Merged

dev/v0.1.4: add GitHub Pages documentation workflow#5
NanoBiostructuresRG merged 2 commits into
mainfrom
dev/v0.1.4

Conversation

@NanoBiostructuresRG

Copy link
Copy Markdown
Owner

Summary

This PR prepares HDDFlyzer v0.1.4 as the documentation web / GitHub Pages readiness cycle.

Changes

  • Added a dedicated GitHub Actions workflow for MkDocs documentation validation and GitHub Pages deployment.
  • Validates documentation with mkdocs build --strict.
  • Keeps deployment restricted to pushes on main.
  • Added/updated v0.1.4 documentation metadata.
  • Updated package version metadata to 0.1.4.
  • Updated citation, changelog, roadmap, README, and MkDocs configuration.
  • Added site_url for the GitHub Pages site.
  • Preventively constrained MkDocs to <2.0 in the documentation optional dependencies.

Validation

  • CI passed on dev/v0.1.4.
  • Docs workflow passed on dev/v0.1.4.
  • Local validation reported:
    • python -m mkdocs build --strict OK
    • python -m pytest tests -q OK, 290 passed, 1 skipped
    • python -m build OK
    • package/import version reports 0.1.4
    • git diff --check OK

Notes

  • This PR does not publish to PyPI.
  • GitHub Pages deployment is expected only after merge to main.
  • No scientific logic, pipeline behavior, outputs, or runtime API behavior were changed.

@NanoBiostructuresRG NanoBiostructuresRG merged commit c1b84b5 into main Jun 13, 2026
6 checks passed
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.

1 participant