kornia/kornia

[Feature]: Migrate docs to mkdocs

Open

#3,454 创建于 2026年1月4日

在 GitHub 查看
 (3 评论) (0 反应) (0 负责人)Python (8,677 star) (892 fork)batch import
Difficulty: mediumhelp wantedtriage

描述

🚀 Feature Description

The existing documentation is generated with sphinx but we want to modernize with mkdocs to be built also from github.

📂 Feature Category

Documentation

💡 Motivation

Modernize the documentation and build pipeline

💭 Proposed Solution

Contiinue the work from this branch: https://github.com/kornia/kornia/tree/mkdocs

🤝 Contribution Intent

  • I plan to submit a PR to implement this feature
  • I'm requesting this feature but not planning to implement it

贡献者指南

技术栈
python
领域
documentation
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-2 days
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Python knowledgeSphinx basicsMkdocs basics
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
70
研究方向
Continue the work from the mkdocs branch at https://github.com/kornia/kornia/tree/mkdocs. Review the existing documentation structure under docs/ (or wherever sphinx docs are). Consult the maintainers for any specific requirements or configurations needed for the new mkdocs setup.