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

Enable mike for docs versioning #51

Merged
merged 8 commits into from
Sep 7, 2023
Merged
Show file tree
Hide file tree
Changes from 3 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: 2 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -64,3 +64,5 @@ jobs:

- name: Zig Docs Build
run: poetry run python -m ziglang build docs
- name: MKDocs Build
run: poetry run mike deploy develop --push
11 changes: 2 additions & 9 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -59,16 +59,9 @@ jobs:
- name: Zig Docs Build
run: poetry run python -m ziglang build docs
- name: MKDocs Build
run: poetry run mkdocs build
run: poetry run mike deploy ${{ github.ref_name }} latest --push

- name: Publish package distributions to PyPI
uses: pypa/gh-action-pypi-publish@release/v1

- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
- uses: actions/cache@v3
with:
key: mkdocs-material-${{ env.cache_id }}
path: .cache
restore-keys: |
mkdocs-material-
- run: poetry run mkdocs gh-deploy --force

3 changes: 3 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,12 @@ extra:
link: https://hub.docker.com/r/squidfunk/mkdocs-material/
- icon: fontawesome/brands/python
link: https://pypi.org/project/ziggy-pydust/
version:
provider: mike

plugins:
- include-markdown
- mike

markdown_extensions:
- admonition
Expand Down
37 changes: 36 additions & 1 deletion 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 @@ -27,6 +27,7 @@ black = "^23.7.0"
ziglang = "^0.11.0"
mkdocs-material = "^9.2.6"
mkdocs-include-markdown-plugin = { version = "^6.0.1", python = "<3.13" }
mike = "^1.1.2"

[tool.poetry.scripts]
pydust = "pydust.__main__:main"
Expand Down