-
Notifications
You must be signed in to change notification settings - Fork 128
Comments
Migrate documentation to use Zensical instead of MkDocs#1557
Migrate documentation to use Zensical instead of MkDocs #1557tleonhardt merged 6 commits intomain from
Conversation
For now leave the configuration in mkdocs.yml. TODO later: Migrate configuration to zensical.toml
🤖 Hi @tleonhardt, I've received your request, and I'm working on it now! You can track my progress in the logs for more details.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@ ## main #1557 +/- ## ======================================= Coverage 98.94% 98.94% ======================================= Files 21 21 Lines 4942 4942 ======================================= Hits 4890 4890 Misses 52 52
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
📋 Review Summary
This Pull Request successfully migrates the documentation system from MkDocs to Zensical. The changes are consistent across configuration files, workflow definitions, and documentation content, demonstrating a thorough transition.
🔍 General Feedback
- The updates to dependency groups in
pyproject.tomlcorrectly reflect the new documentation tool, removing obsolete packages and addingzensical. - Documentation files and scripts have been consistently updated to refer to Zensical, ensuring accuracy and coherence.
- The change to use linked references in
docs/features/argument_processing.mdis a good improvement for documentation usability.
Also: - "make docs" now also automatically opens site in default browser - Made a few small simplifications in mkdocs.yml
Uh oh!
There was an error while loading. Please reload this page.
Migrate documentation to use Zensical instead of MkDocs with the Material theme.
Zensicalis essentially "MkDocs 2.0" and is backwards compatible.I decided not to try to migrate to a
zensical.tomlfile at this point as zensical fully supports directly using the configuration inmkdocs.ymland Zensical has on their roadmap a tool for automatically converting the config file for you.The developer experience of using
Zensicalis awesome as it has a much faster reload time for the static site after updating documentation.TODO:
zensical(I also migrated it to useuvinstead of pip in the process)