8000 Add mkdocs mike for versioning by kkinder · Pull Request #75 · kkinder/puepy · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Add mkdocs mike for versioning #75

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

Merged
merged 1 commit into from
Feb 16, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/docs-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ jobs:

- name: Build docs
run: |
poetry run mkdocs build
poetry run mike deploy -u -b docs-releases development

- name: Package and upload Pages artifact
uses: actions/upload-pages-artifact@v3
Expand Down
4 changes: 4 additions & 0 deletions docs/overrides/main.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{% block outdated %}
You're not viewing the latest version. Try viewing the
<a href="{{ '../' ~ base_url }}"><strong>latest version</strong></a>.
{% endblock %}
17 changes: 17 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,14 @@
site_name: PuePy Documentation
site_url: https://docs.puepy.dev/
site_author: Ken Kinder

repo_name: kkinder/puepy
repo_url: https://github.com/kkinder/puepy
edit_uri: ""

theme:
name: material
custom_dir: docs/overrides
palette:

# Palette toggle for automatic mode
Expand Down Expand Up @@ -53,6 +60,11 @@ markdown_extensions:
plugins:
- search
- macros
- mike:
alias_type: redirect
redirect_template: null
canonical_version: stable
version_selector: true
- mkdocstrings:
default_handler: python
handlers:
Expand Down Expand Up @@ -104,3 +116,8 @@ hooks:
- docs/puepy_hooks.py
extra:
project_version: "0.6.0"
version:
provider: mike
default:
- stable
- development
83 changes: 80 additions & 3 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ beautifulsoup4 = "^4.13.3"
mkdocs-material-extensions = "^1.3.1"
mkdocstrings = {extras = ["python"], version = "^0.28.1"}
mkdocs-macros-plugin = "^1.3.7"
mike = "^2.1.3"

[build-system]
requires = ["poetry-core"]
Expand Down
Loading
0