Skip to content

Commit 207b3df

Browse files
authored
docs(theme): upgrade mkdocs-material to 8.x (aws-powertools#1002)
1 parent b52b430 commit 207b3df

File tree

7 files changed

+27
-50
lines changed

7 files changed

+27
-50
lines changed

.gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
# Created by https://www.gitignore.io/api/osx,linux,python,windows,pycharm,visualstudiocode
32
# Edit at https://www.gitignore.io/?templates=osx,linux,python,windows,pycharm,visualstudiocode
43

@@ -304,3 +303,4 @@ node_modules
304303
api/
305304
site/
306305
!404.html
306+
!docs/overrides/*.html

docs/index.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -454,5 +454,7 @@ As a best practice, AWS Lambda Powertools module logging statements are suppress
454454
```python title="Powertools debug mode example"
455455
from aws_lambda_powertools.logging.logger import set_package_logger
456456

457-
set_package_logger()
457+
set_package_logger() # (1)
458458
```
459+
460+
1. :information_source: this will configure our `aws_lambda_powertools` logger with debug.
Binary file not shown.

docs/overrides/main.html

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{% extends "base.html" %}
2+
3+
{% block outdated %}
4+
You're not viewing the latest version.
5+
<a href="{{ '../' ~ base_url }}">
6+
<strong>Click here to go to latest.</strong>
7+
</a>
8+
{% endblock %}

mkdocs.yml

+6-3
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,8 @@ theme:
5252
- navigation.top
5353
- navigation.instant
5454
- navigation.indexes
55+
- navigation.tracking
56+
- content.code.annotate
5557
icon:
5658
repo: fontawesome/brands/github
5759
logo: media/aws-logo-light.svg
@@ -60,10 +62,10 @@ theme:
6062

6163
markdown_extensions:
6264
- admonition
63-
- pymdownx.tabbed
65+
- pymdownx.tabbed:
66+
alternate_style: true
6467
- pymdownx.highlight:
6568
linenums: true
66-
- pymdownx.superfences
6769
- pymdownx.details
6870
- pymdownx.snippets:
6971
base_path: "."
@@ -75,7 +77,7 @@ markdown_extensions:
7577
- attr_list
7678
- pymdownx.emoji
7779
- pymdownx.inlinehilite
78-
- attr_list
80+
- pymdownx.superfences
7981

8082
copyright: Copyright &copy; 2021 Amazon Web Services
8183

@@ -92,3 +94,4 @@ extra_javascript:
9294
extra:
9395
version:
9496
provider: mike
97+
default: latest

poetry.lock

+8-44
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pyproject.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,10 +50,10 @@ radon = "^5.1.0"
5050
xenon = "^0.8.0"
5151
flake8-eradicate = "^1.2.0"
5252
flake8-bugbear = "^22.1.11"
53-
mkdocs-material = "^7.3.6"
5453
mkdocs-git-revision-date-plugin = "^0.3.1"
5554
mike = "^0.6.0"
5655
mypy = "^0.931"
56+
mkdocs-material = "^8.1.9"
5757

5858

5959
[tool.poetry.extras]

0 commit comments

Comments
 (0)