Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: Update documentation publishing workflow with mike #44

Merged
merged 4 commits into from
Mar 22, 2025
Merged

feat: Update documentation publishing workflow with mike #44

merged 4 commits into from
Mar 22, 2025

Conversation

eyedol
Copy link
Member

@eyedol eyedol commented Mar 13, 2025

  • Configure git for mike to deploy documentation to gh-pages.
  • Deploy dev (snapshot) docs using mike.
  • Deploy release docs using mike.
  • Add mike plugin to mkdocs.yml for version management.
  • Set the version number in mkdocs using the environment variables.
  • Update the trigger in the workflow to only trigger for main branch.

eyedol added 4 commits March 13, 2025 12:59
@eyedol
feat: Update documentation publishing workflow with mike
398203e 
- Configure git for mike to deploy documentation to `gh-pages`.
- Deploy dev (snapshot) docs using `mike`.
- Deploy release docs using `mike`.
- Add `mike` plugin to `mkdocs.yml` for version management.
- Set the version number in mkdocs using the environment variables.
- Update the trigger in the workflow to only trigger for `main` branch.
@eyedol
Add script to delete old versions docs and make delete_old_version_do…
f67efb4 
…cs.sh executable
@eyedol
Move install_hooks.sh to scripts directory
c1c67c6
@eyedol
Make release.sh executable
099da02
@eyedol eyedol marked this pull request as ready for review March 22, 2025 22:19
@eyedol eyedol merged commit 5a19283 into main Mar 22, 2025
4 checks passed
@eyedol eyedol deleted the addVersionsToSiteDocs branch March 22, 2025 22:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@eyedol