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/docs/assets/css/custom.css b/docs/assets/css/custom.css index 8ac595659..32fb73e9d 100644 --- a/docs/assets/css/custom.css +++ b/docs/assets/css/custom.css @@ -1,52 +1,22 @@ -/* https://github.com/squidfunk/mkdocs-material/issues/1522 */ -.md-typeset h5 { - color: var(--md-default-fg-color); - text-transform: none; +:root > * { + /* Use font but disable ligatures, see https://github.com/pypa/hatch/issues/104 */ + font-variant-ligatures: none; } /* Brighter links for dark mode */ [data-md-color-scheme=slate] { - /* https://github.com/squidfunk/mkdocs-material/blob/7.3.6/src/assets/stylesheets/main/_colors.scss */ + /* https://github.com/squidfunk/mkdocs-material/blob/9.1.2/src/assets/stylesheets/main/_colors.scss#L91-L92 */ --md-typeset-a-color: var(--md-primary-fg-color--light); } /* FiraCode https://github.com/tonsky/FiraCode */ code { font-family: 'Fira Code', monospace; } - @supports (font-variation-settings: normal) { code { font-family: 'Fira Code VF', monospace; } } -/* https://github.com/pypa/hatch/issues/104 */ -:root { - font-variant-ligatures: none; -} - -/* Everything below is from https://mkdocstrings.github.io/python/customization/#recommended-style-material */ - -/* Indentation. */ -div.doc-contents:not(.first) { - padding-left: 25px; - border-left: .05rem solid var(--md-typeset-table-color); -} - -/* Mark external links as such. */ -a.autorefs-external::after { - /* https://primer.style/octicons/arrow-up-right-24 */ - background-image: url('data:image/svg+xml,'); - content: ' '; - - display: inline-block; - position: relative; - top: 0.1em; - margin-left: 0.2em; - margin-right: 0.1em; - - height: 1em; - width: 1em; - border-radius: 100%; - background-color: var(--md-typeset-a-color); -} -a.autorefs-external:hover::after { - background-color: var(--md-accent-fg-color); +/* https://github.com/squidfunk/mkdocs-material/issues/1522 */ +.md-typeset h5 { + color: var(--md-default-fg-color); + text-transform: none; } diff --git a/docs/history/hatch.md b/docs/history/hatch.md index cf5eafdc5..7cdd4b85f 100644 --- a/docs/history/hatch.md +++ b/docs/history/hatch.md @@ -18,6 +18,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), - Add standalone binaries - Bump the minimum supported version of Hatchling to 1.17.1 +- Bump the minimum supported version of `click` to 8.0.6 ## [1.7.0](https://github.com/pypa/hatch/releases/tag/hatch-v1.7.0) - 2023-04-03 ## {: #hatch-v1.7.0 } diff --git a/docs/install.md b/docs/install.md index 89bbc6987..ae7d3f893 100644 --- a/docs/install.md +++ b/docs/install.md @@ -10,7 +10,6 @@ Each [release](https://github.com/pypa/hatch/releases) provides the following: - Windows AMD64 (64-bit) MSI installer - Windows x86 (32-bit) MSI installer - Windows universal (AMD64+x86) EXE installer -- macOS DMG installer ## pip diff --git a/hatch.toml b/hatch.toml index de59c01b6..42dd5b43d 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.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", diff --git a/mkdocs.insiders.yml b/mkdocs.insiders.yml index 8a6cf890f..d47495530 100644 --- a/mkdocs.insiders.yml +++ b/mkdocs.insiders.yml @@ -1,7 +1,7 @@ INHERIT: mkdocs.yml plugins: - blog: + material/blog: categories_allowed: - General - News diff --git a/mkdocs.yml b/mkdocs.yml index 1fdc3144e..add15ff8a 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: @@ -235,4 +239,4 @@ extra: link: https://www.linkedin.com/in/ofeklev/ extra_css: - assets/css/custom.css - - https://cdn.jsdelivr.net/gh/tonsky/FiraCode@5.2/distr/fira_code.css + - https://cdn.jsdelivr.net/npm/firacode@6.2.0/distr/fira_code.css diff --git a/pyproject.toml b/pyproject.toml index c8637f4a6..ae005efde 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -37,7 +37,7 @@ classifiers = [ "Topic :: Software Development :: Build Tools", ] dependencies = [ - "click>=8.0.3", + "click>=8.0.6", "hatchling>=1.14.0", "httpx>=0.22.0", "hyperlink>=21.0.0", diff --git a/scripts/install_mkdocs_material_insiders.py b/scripts/install_mkdocs_material_insiders.py index 3251905b0..5004df277 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 = 'd03fc7efdb0f1432b8170a4e12285971bd6cdcb2' def main():