Repository navigation
docs: switch from mkdocs to properdocs - #2946
Merged
Merged
Conversation
properdocs is a drop-in MkDocs fork by the original MkDocs maintainers. The existing plugins (include-markdown, macros, intersphinx) and pymdown extensions work unchanged; themes are unbundled, so the readthedocs theme comes from properdocs-theme-readthedocs. Assisted-by: ClaudeCode:claude-fable-5
Contributor
|
Nice! This seems like a step forward, and away from the unmaintained mkdocs. (I would like to modernise the docs at some point, and make it easier to include the more custom elements (e.g. the envvar/toml tabs, the options page headers, the 'how it works' diagram) in a less hacky way. I do have half an eye on Starlight with this in mind. But that's a topic for another day.) |
joerick
approved these changes
Jul 24, 2026
joerick
left a comment
Contributor
There was a problem hiding this comment.
I know it's draft but I've had a good browse through the RtD build and it looks identical to me!
Contributor
Author
|
The only thing I saw when looking through was the missing identifier (which has nothing to do with this change), so I can take it out of draft. GH is having some issues at the moment, I think. |
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
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.
I evaluated zensical and Great Docs too; zensical is still missing stuff we need and forces the material theme, and Great Docs uses a quarto binary (heavy) and is really focused on API rather than narrative.
MkDocs is no longer developed publicly (or at all?) (along with httpx, same author), and hasn't had a new release in two years. If there is another release, it won't support plugins. See the slow collapse of mkdocs for context.
🤖 AI text below 🤖
Switches the docs build from MkDocs to properdocs, the drop-in MkDocs fork maintained by the original MkDocs authors.
Changes:
mkdocs.yml→properdocs.yml(content unchanged; properdocs errors on an implicitmkdocs.ymlfallback)pyproject.toml:mkdocs==1.6.1→properdocs==1.6.7, plusproperdocs-theme-readthedocs(themes are unbundled from the core package)noxfile.pyand.readthedocs.yml; CI path filters updatedThe existing plugins (
mkdocs-include-markdown-plugin,mkdocs-macros-plugin,mkdocs-intersphinx) and pymdown extensions work unchanged — properdocs reads themkdocs.plugins/mkdocs.themesentry points.properdocs build --strictpasses locally, including the macros-generated options page and the intersphinx inventory.Draft: evaluating whether we want to make this switch; also worth checking the Read the Docs build preview before merging.