feat: replace MkDocs with ProperDocs#838
Merged
Merged
Conversation
Switch the mkdocs docs option to properdocs, the maintained drop-in fork of MkDocs. The config file becomes properdocs.yml, the docs group swaps mkdocs for properdocs, and nox/Read the Docs run the properdocs CLI. mkdocs-material and mkdocstrings work unchanged. Existing copier users will need to update their docs answer from mkdocs to properdocs. Assisted-by: ClaudeCode:claude-fable-5
henryiii
commented
Jul 24, 2026
henryiii
commented
Jul 24, 2026
henryiii
marked this pull request as ready for review
July 24, 2026 18:08
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🤖 AI text below 🤖
Switches the
mkdocsdocs option to ProperDocs, the maintained drop-in fork of MkDocs by a former MkDocs maintainer.mkdocs→properdocs; the config file is nowproperdocs.yml(ProperDocs still readsmkdocs.ymlas a deprecated fallback).mkdocs>=1.1.2forproperdocs>=1.6.7;mkdocs-materialandmkdocstringswork unchanged (they still pull in mkdocs as a library — ProperDocs is the runner and loads plugins from both entry-point groups).properdocsCLI; the guide and tutorial pages are updated, with cog blocks regenerated.Verified beyond CI: built a generated project's docs with the full material + mkdocstrings + autorefs stack under ProperDocs.
Note for existing copier users: the recorded
docs: mkdocsanswer must be updated toproperdocsbefore runningcopier update— worth a changelog note.📚 Documentation preview 📚: https://scientific-python-cookie--838.org.readthedocs.build/