Skip to content

Commit

Permalink
try to add mike
Browse files Browse the repository at this point in the history
  • Loading branch information
zzstoatzz committed Dec 10, 2023
1 parent 80b6c64 commit 5500bdc
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 9 deletions.
18 changes: 14 additions & 4 deletions .github/workflows/publish-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ name: Publish Docs
on:
push:
branches: ["main"]
tags:
- 'v*'
workflow_dispatch:

env:
Expand All @@ -11,6 +13,7 @@ env:

permissions:
contents: write

jobs:
publish-docs:
runs-on: ubuntu-latest
Expand All @@ -23,7 +26,6 @@ jobs:
with:
key: ${{ github.ref }}
path: .cache
# for now, only install mkdocs. In the future may need to install Marvin itself.
- name: Install dependencies for MKDocs Material
run: pip install \
mkdocs-material \
Expand All @@ -33,6 +35,14 @@ jobs:
mkdocs-markdownextradata-plugin \
mkdocs-jupyter \
pillow \
cairosvg
- name: Publish docs
run: mkdocs gh-deploy --force
cairosvg \
mike
- name: Publish docs from `main` to dev
if: github.ref == 'refs/heads/main'
run: mike deploy dev --push --update-aliases

- name: Publish versioned docs
if: startsWith(github.ref, 'refs/tags/v')
run: |
VERSION=$(echo $GITHUB_REF | sed 's/refs\/tags\/v//')
mike deploy $VERSION latest --push --update-aliases
10 changes: 6 additions & 4 deletions docs/static/css/tailwind.css
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
! tailwindcss v3.3.3 | MIT License | https://tailwindcss.com
! tailwindcss v3.3.6 | MIT License | https://tailwindcss.com
*/

/*
Expand Down Expand Up @@ -121,8 +121,10 @@ strong {
}

/*
1. Use the user's configured `mono` font family by default.
2. Correct the odd `em` font sizing in all browsers.
1. Use the user's configured `mono` font-family by default.
2. Use the user's configured `mono` font-feature-settings by default.
3. Use the user's configured `mono` font-variation-settings by default.
4. Correct the odd `em` font sizing in all browsers.
*/

code,
Expand All @@ -132,7 +134,7 @@ pre {
font-family: ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, "Liberation Mono", "Courier New", monospace;
/* 1 */
font-size: 1em;
/* 2 */
/* 4 */
}

/*
Expand Down
4 changes: 3 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,9 @@ extra:
link: https://discord.gg/Kgw4HpcuYG
- icon: fontawesome/brands/twitter
link: https://twitter.com/askmarvinai

version:
mike:
canonical_version: latest

extra_css:
- /static/css/global.css
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ dev = [
"marvin[tests]",
"black[jupyter]",
"ipython",
"mike @ git+https://github.com/jimporter/mike.git",
"mkdocs-autolinks-plugin~=0.7",
"mkdocs-awesome-pages-plugin~=2.8",
"mkdocs-markdownextradata-plugin~=0.2",
Expand Down

0 comments on commit 5500bdc

Please sign in to comment.