描述

按照 A Modern Python Package Template - MPPT学习 python 项目结构。
尝试在rye 搭建 python 和 rust 混合项目基础上，添加文档和任务执行器。

• Documentation：Mkdocs。

  MKDOCS 是一个快速，简单，彻头彻尾的华丽静态站点生成器，旨在构建项目文档。 文档源文件写在 Markdown 中，并配置了一个 YAML 配置文件。

• Taskrunner：使用rye的scripts就不错，在此尝试了 duty 和 just。

  duty
  

  image.png

just

image.png

目前我需要执行的任务比较简单，按照官方文档介绍写就行了，本文主要介绍用 mkdocs 为代码写文档。

mkdocs 基本命令

1. 初始化

   pip install mkdocs
   mkdocs new project
   
   project
   |_ mkdocs.yml
   |_ docs
     |_ index.mk
   

2. 更改主题
   下载主题

   pip install mkdocs-material
   

   修改mkdocs.yml

   site_name: MkLorum
   nav:
     - Home: index.md
   theme: material
   

3. 启动服务

   mkdocs serve
   

   浏览器打开http://127.0.0.1:8000/

4. 制作网站

   mkdocs build
   

   浏览器打开 file:///path/to/project/site/index.html

rye 下的配置

rye不想暴露pip，使用 rye install 全局安装mkdocs和mkdocs-material可能无法正常调用。
需要用 rye 在这个项目下的隐藏文件夹.venv 里的pip，即在虚拟环境中安装：

1. 首先在开发环境下安装pip

   rye add --dev pip
   rye sync
   

2. 启动rye的shell：

   rye shell
   pip install mkdocs mkdocs-material
   

3. 不启动：

   rye run pip install mkdocs mkdocs-material