1
0
mirror of https://github.com/square/okhttp.git synced 2025-04-19 07:42:15 +03:00
okhttp/mkdocs.yml
Jared Burrows 4ba74c7f9c
Fix pymdownx.emoji extension warning (#8559)
## Description
 - Fix pymdownx.emoji extension warning

## Repro
 - `mkdocs build`

## Warning
```
❯ mkdocs build
INFO    -  DeprecationWarning: 'materialx.emoji.twemoji' is deprecated.
           Material emoji logic has been officially moved into mkdocs-material
           version 9.4. Please use Material's 'material.extensions.emoji.twemoji'
           instead of 'materialx.emoji.twemoji' in your 'mkdocs.yml' file.

           ```
           markdown_extensions:
             - pymdownx.emoji:
                 emoji_index: !!python/name:material.extensions.emoji.twemoji
                 emoji_generator: !!python/name:material.extensions.emoji.to_svg
           ```

           'mkdocs_material_extensions' is deprecated and will no longer be
           supported moving forward. This is the last release.

             File "/opt/homebrew/lib/python3.12/site-packages/materialx/emoji.py", line 118, in twemoji
               return _patch_index(options)
             File "/opt/homebrew/lib/python3.12/site-packages/materialx/emoji.py", line 68, in _deprecated_func
               warnings.warn(
WARNING -  Material emoji logic has been officially moved into mkdocs-material
           version 9.4. Please use Material's 'material.extensions.emoji.twemoji'
           instead of 'materialx.emoji.twemoji' in your 'mkdocs.yml' file.

           ```
           markdown_extensions:
             - pymdownx.emoji:
                 emoji_index: !!python/name:material.extensions.emoji.twemoji
                 emoji_generator: !!python/name:material.extensions.emoji.to_svg
           ```

           'mkdocs_material_extensions' is deprecated and will no longer be
           supported moving forward. This is the last release.
INFO    -  Cleaning site directory
INFO    -  Building documentation to directory: /Users/<>/Downloads/site
INFO    -  Documentation built in 0.13 seconds
```

Co-authored-by: Jesse Wilson <jesse@swank.ca>
2024-11-21 07:19:31 +00:00

118 lines
3.9 KiB
YAML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

site_name: OkHttp
site_url: https://square.github.io/okhttp/
repo_name: OkHttp
repo_url: https://github.com/square/okhttp
site_description: "Squares meticulous HTTP client for the JVM, Android, and GraalVM"
site_author: Square, Inc.
remote_branch: gh-pages
edit_uri: ""
copyright: 'Copyright &copy; 2022 Block, Inc.'
theme:
name: 'material'
favicon: assets/images/icon-square.png
logo: assets/images/icon-square.png
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: teal
accent: blue
toggle:
icon: octicons/sun-24
name: "Switch to Dark Mode"
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: teal
accent: blue
toggle:
icon: octicons/moon-24
name: "Switch to Light Mode"
features:
- navigation.tabs
extra_css:
- 'assets/css/app.css'
markdown_extensions:
- smarty
- footnotes
- meta
- toc:
permalink: true
- attr_list
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.inlinehilite
- pymdownx.magiclink
- pymdownx.smartsymbols
- pymdownx.superfences
- pymdownx.tilde
- pymdownx.tabbed:
alternate_style: true
- tables
plugins:
- search
- redirects:
redirect_maps:
# Redirect all feature pages to features/*
'caching.md': 'features/caching.md'
'calls.md': 'features/calls.md'
'connections.md': 'features/connections.md'
'events.md': 'features/events.md'
'https.md': 'features/events.md'
'interceptors.md': 'features/interceptors.md'
'r8_proguard.md': 'features/r8_proguard.md'
# Redirect all Security pages to security/*
'security.md': 'security/security.md'
'security_providers.md': 'security/security_providers.md'
'tls_configuration_history.md': 'security/tls_configuration_history.md'
# Redirect all changelog pages to changelog/*
'changelog.md': 'changelogs/changelog.md'
'upgrading_to_okhttp_4.md': 'changelogs/upgrading_to_okhttp_4.md'
'changelog_3x.md': 'changelogs/changelog_3x.md'
'changelog_2x.md': 'changelogs/changelog_2x.md'
'changelog_1x.md': 'changelogs/changelog_1x.md'
# Redirect all contributing pages to contribute/*
'contributing.md': 'contribute/contributing.md'
'code_of_conduct.md': 'contribute/code_of_conduct.md'
'concurrency.md': 'contribute/concurrency.md'
'debug_logging.md': 'contribute/debug_logging.md'
nav:
- 'Overview':
- 'Overview': index.md
- 'Stack Overflow': https://stackoverflow.com/questions/tagged/okhttp?sort=active
- 'Features':
- 'Calls': features/calls.md
- 'Caching': features/caching.md
- 'Connections': features/connections.md
- 'Events': features/events.md
- 'HTTPS': features/https.md
- 'Interceptors': features/interceptors.md
- 'R8/Proguard': features/r8_proguard.md
- 'Recipes': recipes.md
- 'Security':
- 'Security': security/security.md
- 'Providers': security/security_providers.md
- 'Configuration History': security/tls_configuration_history.md
- 'Works with OkHttp': works_with_okhttp.md
- 'API': 5.x/okhttp/okhttp3/
- 'Change Logs':
- 'Change Log': changelogs/changelog.md
- '4.x Change Log': changelogs/changelog_4x.md
- 'Upgrading to OkHttp 4': changelogs/upgrading_to_okhttp_4.md
- '3.x Change Log': changelogs/changelog_3x.md
- '2.x Change Log': changelogs/changelog_2x.md
- '1.x Change Log': changelogs/changelog_1x.md
- 'Contributing':
- 'Contributing': contribute/contributing.md
- 'Code of Conduct': contribute/code_of_conduct.md
- 'Concurrency': contribute/concurrency.md
- 'Debug Logging': contribute/debug_logging.md