Skip to content

Conversation

@tleonhardt
Copy link
Member

@tleonhardt tleonhardt commented Jan 20, 2026

Migrate documentation to use Zensical instead of MkDocs with the Material theme. Zensical is essentially "MkDocs 2.0" and is backwards compatible.

I decided not to try to migrate to a zensical.toml file at this point as zensical fully supports directly using the configuration in mkdocs.yml and Zensical has on their roadmap a tool for automatically converting the config file for you.

The developer experience of using Zensical is awesome as it has a much faster reload time for the static site after updating documentation.

TODO:

  • Fix ReadTheDocs build to work with zensical (I also migrated it to use uv instead of pip in the process)

For now leave the configuration in mkdocs.yml.

TODO later: Migrate configuration to zensical.toml
@tleonhardt tleonhardt added this to the 4.0.0 milestone Jan 20, 2026
@tleonhardt tleonhardt self-assigned this Jan 20, 2026
@github-actions
Copy link
Contributor

🤖 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
Copy link

codecov bot commented Jan 20, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.94%. Comparing base (c7367d6) to head (e088723).
⚠️ Report is 1 commits behind head on main.

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           
Flag Coverage Δ
unittests 98.94% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@tleonhardt tleonhardt mentioned this pull request Jan 20, 2026
13 tasks
Copy link
Contributor

@github-actions github-actions bot left a 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.toml correctly reflect the new documentation tool, removing obsolete packages and adding zensical.
  • 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.md is a good improvement for documentation usability.

@tleonhardt tleonhardt marked this pull request as ready for review January 20, 2026 03:04
@tleonhardt tleonhardt merged commit be4a177 into main Jan 21, 2026
30 checks passed
@tleonhardt tleonhardt deleted the zensical branch January 21, 2026 00:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants