Skip to content

docs(theme): upgrade mkdocs material to 8.x #534

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 15, 2022
Merged

docs(theme): upgrade mkdocs material to 8.x #534

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ccee1ee
chore: bump mkdocs + add annotation plugins
dreamorosi Feb 4, 2022
d1782d5
docs: updated year in copyright notice
dreamorosi Feb 9, 2022
44f56d2
chore: remove redundant ignore
dreamorosi Feb 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ venv

# Static documentation site generated by Mkdocs
site
!docs/overrides/*.html
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we need an override to be included in git. Is it being ignored somewhere else?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If it really needs to be in this file, a comment would be useful for future contributors.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch, remove it in the latest commit.


# Generated API documentation (from TypeDoc)
/api
Binary file removed docs/overrides/assets/images/powertools_docs_thumbnail.png
View file
Open in desktop
Binary file not shown.
8 changes: 8 additions & 0 deletions docs/overrides/main.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{% extends "base.html" %}

{% block outdated %}
You're not viewing the latest version.
<a href="{{ '../' ~ base_url }}">
<strong>Click here to go to latest.</strong>
</a>
{% endblock %}
2 changes: 1 addition & 1 deletion docs/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
mike==1.1.2
mkdocs-material==8.0.5
mkdocs-material==8.1.9
mkdocs-git-revision-date-plugin==0.3.1
7 changes: 6 additions & 1 deletion mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,10 @@ theme:
- navigation.sections
- navigation.expand
- navigation.top
- navigation.instant
- navigation.indexes
- navigation.tracking
- content.code.annotate
icon:
repo: fontawesome/brands/github
logo: media/aws-logo-light.svg
Expand All @@ -58,7 +62,7 @@ markdown_extensions:
- attr_list
- pymdownx.emoji
- pymdownx.inlinehilite
- attr_list
- pymdownx.superfences

copyright: Copyright &copy; 2021 Amazon Web Services

Expand All @@ -75,3 +79,4 @@ extra_javascript:
extra:
version:
provider: mike
default: latest