Skip to content

Commit 1ea2702

Browse files
committed
docs update
1 parent 6d8f971 commit 1ea2702

2 files changed

Lines changed: 33 additions & 3 deletions

File tree

.github/workflows/docs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@ jobs:
4646
if: startsWith(github.ref, 'refs/tags/')
4747
run: |
4848
VERSION="${GITHUB_REF_NAME#v}"
49-
uv run mike deploy --push --update-aliases "$VERSION" latest
49+
uv run mike deploy --push --update-aliases --alias-type redirect "$VERSION" latest
5050
uv run mike set-default --push latest
5151
- name: Deploy dev docs (main push)
5252
if: github.ref == 'refs/heads/main'
53-
run: uv run mike deploy --push dev
53+
run: uv run mike deploy --push --alias-type redirect dev

mkdocs.yml

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,24 +7,39 @@ edit_uri: edit/main/docs/
77

88
theme:
99
name: material
10+
icon:
11+
repo: fontawesome/brands/github
1012
palette:
1113
- media: "(prefers-color-scheme: light)"
1214
scheme: default
1315
primary: indigo
16+
accent: indigo
1417
toggle:
1518
icon: material/brightness-7
1619
name: Switch to dark mode
1720
- media: "(prefers-color-scheme: dark)"
1821
scheme: slate
1922
primary: indigo
23+
accent: indigo
2024
toggle:
2125
icon: material/brightness-4
2226
name: Switch to light mode
2327
features:
2428
- navigation.instant
29+
- navigation.instant.progress
2530
- navigation.tracking
31+
- navigation.tabs
32+
- navigation.sections
33+
- navigation.indexes
2634
- navigation.top
35+
- navigation.footer
36+
- toc.follow
37+
- search.suggest
38+
- search.highlight
39+
- search.share
2740
- content.code.copy
41+
- content.code.annotate
42+
- content.tabs.link
2843
- content.action.edit
2944

3045
nav:
@@ -58,9 +73,19 @@ plugins:
5873

5974
markdown_extensions:
6075
- admonition
61-
- pymdownx.highlight
76+
- attr_list
77+
- md_in_html
78+
- tables
79+
- pymdownx.highlight:
80+
anchor_linenums: true
6281
- pymdownx.superfences
6382
- pymdownx.inlinehilite
83+
- pymdownx.tabbed:
84+
alternate_style: true
85+
- pymdownx.details
86+
- pymdownx.emoji:
87+
emoji_index: !!python/name:material.extensions.emoji.twemoji
88+
emoji_generator: !!python/name:material.extensions.emoji.to_svg
6489
- pymdownx.snippets:
6590
base_path: ["."]
6691
check_paths: true
@@ -70,3 +95,8 @@ markdown_extensions:
7095
extra:
7196
version:
7297
provider: mike
98+
social:
99+
- icon: fontawesome/brands/github
100+
link: https://github.com/exprtec/instantlyai-python-sdk
101+
- icon: fontawesome/brands/python
102+
link: https://pypi.org/project/instantlyai/

0 commit comments

Comments
 (0)