Skip to content

build: Use mkdocs-material 9.5.3, drop git-authors theme override#257

Merged
fghaas merged 1 commit intocleura:mainfrom
fghaas:authors
Jan 2, 2024
Merged

build: Use mkdocs-material 9.5.3, drop git-authors theme override#257
fghaas merged 1 commit intocleura:mainfrom
fghaas:authors

Conversation

@fghaas
Copy link
Copy Markdown
Contributor

@fghaas fghaas commented Dec 12, 2023

What will probably become mkdocs-material 9.5.3 gives us the ability to again render authors' names without them turning into "mailto:" links. Thus, require that as the minimum version. Since it is now mkdocs-material that natively renders author information, we no longer need the theme override for main.html.

References:
https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#document-authors
squidfunk/mkdocs-material#6494

@fghaas fghaas changed the title build: Use fork of mkdocs-material, drop git-authors theme override build: Use mkdocs-material master, drop git-authors theme override Dec 12, 2023
tox.ini Outdated
mkdocs-glightbox
mkdocs-macros-plugin
mkdocs-material~=9.4.0
git+https://github.com/squidfunk/mkdocs-material@master
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@colder-is-better: Just a heads-up that this exists. I will update this line to mkdocs-material>=9.5.3 once that version is released, and then I will mark this PR ready for review.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Ack, thanks.

mkdocs-material 9.5.3 gives us the ability to again render authors'
names without them turning into "mailto:" links. Thus, require that as
the minimum version. Since it is now mkdocs-material that natively
renders author information, we no longer need the theme override for
main.html.

References:
https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#document-authors
squidfunk/mkdocs-material#6494
@fghaas fghaas marked this pull request as ready for review December 25, 2023 20:23
@fghaas fghaas changed the title build: Use mkdocs-material master, drop git-authors theme override build: Use mkdocs-material 9.5.3, drop git-authors theme override Dec 28, 2023
@fghaas fghaas merged commit 1620562 into cleura:main Jan 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants