diff --git a/.github/workflows/docs-dev.yml b/.github/workflows/docs-dev.yml index 063929a9c..01c42177e 100644 --- a/.github/workflows/docs-dev.yml +++ b/.github/workflows/docs-dev.yml @@ -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 }} diff --git a/hatch.toml b/hatch.toml index de59c01b6..9fd47189f 100644 --- a/hatch.toml +++ b/hatch.toml @@ -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.10", # 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", diff --git a/mkdocs.insiders.yml b/mkdocs.insiders.yml index 8a6cf890f..5e95a1b02 100644 --- a/mkdocs.insiders.yml +++ b/mkdocs.insiders.yml @@ -1,7 +1,10 @@ INHERIT: mkdocs.yml +theme: + name: material + plugins: - blog: + material/blog: categories_allowed: - General - News diff --git a/mkdocs.yml b/mkdocs.yml index 1fdc3144e..8b1f6b4d9 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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: @@ -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: diff --git a/scripts/install_mkdocs_material_insiders.py b/scripts/install_mkdocs_material_insiders.py index 3251905b0..8c72f0814 100644 --- a/scripts/install_mkdocs_material_insiders.py +++ b/scripts/install_mkdocs_material_insiders.py @@ -5,7 +5,7 @@ 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' +GIT_REF = 'e0bf3c9f9def25fe74be73954d24d8c89f661c14' def main():