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.

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

docs: build multi-version documentation #327

Merged
merged 2 commits into from
Dec 3, 2024
Merged

Conversation

bonddim
Copy link
Collaborator

@bonddim bonddim commented Nov 28, 2024

Warning

#326 should be merged first.

GitHub Actions Workflow Enhancements:

  • Trigger workflow on master branch and tags to get documentation versioning.
  • Removed cache step - it's useless without regularly updated requirements.txt
  • Used mkdocs-material[imaging] package to install compatible versions of mkdocs, mkdocs-material, cairosvg and pillow. theme docs

HTML Image Path Corrections:

  • Corrected image paths in docs/theme-overrides/layouts/home.html to include a leading slash for consistency and proper URL resolution.

MkDocs Configuration Improvements:

  • Set site name with '/' for correct redirections between versions.
  • Added configuration for multi-version documentation with mike.
  • Enabled the social and minify plugins and adjusted the features section for navigation.

@bonddim bonddim changed the title Build multi-version docs with 'mike' docs: build multi-version documentation Nov 28, 2024
@bonddim bonddim marked this pull request as ready for review November 28, 2024 16:20
@bonddim bonddim requested a review from h44z November 28, 2024 16:21
@bonddim bonddim marked this pull request as draft November 28, 2024 17:11
@bonddim bonddim marked this pull request as ready for review November 28, 2024 17:44
Copy link
Owner

@h44z h44z left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good =)

@bonddim bonddim merged commit ba9b6c3 into master Dec 3, 2024
5 checks passed
@bonddim bonddim deleted the docs/build-multi-version branch December 3, 2024 18:04
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.

2 participants