Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ofek committed Jul 23, 2023
1 parent afae2ba commit d842d50
Show file tree
Hide file tree
Showing 5 changed files with 24 additions and 17 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/docs-dev.yml
Original file line number Diff line number Diff line change
Expand Up @@ -46,12 +46,12 @@ jobs:
git config --local user.email 'github-actions[bot]@users.noreply.github.com'
- name: Build documentation
run: hatch run docs:build-check
run: hatch -v run docs:build-check
env:
GH_TOKEN_MKDOCS_MATERIAL_INSIDERS: ${{ secrets.GH_TOKEN_MKDOCS_MATERIAL_INSIDERS }}

- name: Commit documentation
run: hatch run docs:ci-build dev
run: hatch -v run docs:ci-build dev
env:
GH_TOKEN_MKDOCS_MATERIAL_INSIDERS: ${{ secrets.GH_TOKEN_MKDOCS_MATERIAL_INSIDERS }}

Expand Down
20 changes: 10 additions & 10 deletions hatch.toml
Original file line number Diff line number Diff line change
Expand Up @@ -69,21 +69,21 @@ all = [

[envs.docs]
dependencies = [
"mkdocs~=1.4.0",
"mkdocs-material~=8.5.6",
"mkdocs~=1.4.3",
"mkdocs-material~=9.1.0",
# Plugins
"mkdocs-minify-plugin~=0.5.0",
"mkdocs-git-revision-date-localized-plugin~=1.1.0",
"mkdocstrings-python~=0.7.1",
"mkdocs-redirects~=1.1.0",
"mkdocs-glightbox~=0.3.0",
"mkdocs-minify-plugin~=0.6.4",
"mkdocs-git-revision-date-localized-plugin~=1.2.0",
"mkdocstrings-python~=1.2.1",
"mkdocs-redirects~=1.2.1",
"mkdocs-glightbox~=0.3.4",
# https://github.com/jimporter/mike/issues/82#issuecomment-1172913929
"mike @ https://github.com/jimporter/mike/archive/392d57b8bb9d14bcedf2451a0dc302709f8055eb.zip",
"mike @ https://github.com/jimporter/mike/archive/be1aafe244bc86172fbce52a903c9ab83e2e4a26.zip",
# Extensions
"mkdocs-click~=0.8.0",
"pymdown-extensions~=9.6.0",
"pymdown-extensions~=10.1.0",
# Necessary for syntax highlighting in code blocks
"pygments~=2.13.0",
"pygments~=2.15.1",
# Validation
# https://github.com/linkchecker/linkchecker/pull/669#issuecomment-1267236287
"linkchecker @ git+https://github.com/linkchecker/linkchecker.git@d9265bb71c2054bf57b8c5734a4825d62505c779",
Expand Down
5 changes: 4 additions & 1 deletion mkdocs.insiders.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
INHERIT: mkdocs.yml

theme:
name: material

plugins:
blog:
material/blog:
categories_allowed:
- General
- News
Expand Down
8 changes: 6 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,14 @@ theme:
icon: material/weather-sunny
name: Switch to dark mode
features:
- navigation.sections
- content.action.edit
- content.code.copy
- navigation.expand
- navigation.footer
- navigation.instant
- navigation.sections
- navigation.tabs
- navigation.tabs.sticky
- navigation.instant

nav:
- Home:
Expand Down Expand Up @@ -129,6 +132,7 @@ plugins:
minify_html: true
git-revision-date-localized:
type: date
strict: false
# Required for blog plugin's generated indices
fallback_to_build_date: true
exclude:
Expand Down
4 changes: 2 additions & 2 deletions scripts/install_mkdocs_material_insiders.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
import sys

TOKEN = os.environ.get('GH_TOKEN_MKDOCS_MATERIAL_INSIDERS', '')
DEP_REF = f'git+https://{TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git'
GIT_REF = '2203a968f9992578460add59056b480ea454ddb3'
DEP_REF = f'git+https://{TOKEN}@github.com/ofek/mkdocs-material-insiders.git'
GIT_REF = 'fix-blog-plugin'


def main():
Expand Down

0 comments on commit d842d50

Please sign in to comment.