Skip to content

Mkdocs Website - #59

Merged
electronsandstuff merged 7 commits into
mainfrom
pierce/mkdocs
Jul 10, 2026
Merged

Mkdocs Website#59
electronsandstuff merged 7 commits into
mainfrom
pierce/mkdocs

Conversation

@electronsandstuff

@electronsandstuff electronsandstuff commented Jul 8, 2026

Copy link
Copy Markdown
Owner

This PR creates a mkdocs documentation website for the project served by Github pages and moves notebooks into it.

  • Add mkdocs.yml
  • Add Github workflow to render and deploy site to Github pages
  • Move example notebooks into docs site
  • Update notebook formatting to render titles correctly (remove inline code markdown elements)
  • Move assets into docs folder
  • Strip notebooks of run content and add to .pre-commit-config.yaml to auto-remove run notebook content.

@electronsandstuff
electronsandstuff merged commit d51ae33 into main Jul 10, 2026
13 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