跳到主要内容

documentation

Mkdocs

Comprehensive guidelines for mkdocs development, covering code organization, best practices, performance, security, testing, common pitfalls, and tooling. This rule aims to ensure maintainable, performant, and secure documentation using mkdocs.

Pdoc

pdoc 的全面最佳实践,用于生成和维护 Python 项目文档。涵盖代码结构、性能、安全、测试和工具,以确保高质量的文档和可维护的项目。

Sphinx

此规则文件提供了编写高质量 Sphinx 文档的全面指南,涵盖代码风格、结构、性能和最佳实践。旨在确保 Sphinx 项目的一致性、可读性和可维护性。