python使用MkDocs自动生成文档 前言使用MkDocs环境相关资料使用介绍项目结构配置文件注释生成文档的配置运行与构建部署 实践的项目 前言 python代码注释风格有很多，比较主流的有 reStructuredText风格、numpy风格、Google风格。 自动生成文档的工具也有很多，常见的有： Pydocs python环境自带，支持MarkDown，但功能比

``` === "C"     ``` c     #include <stdio.h>     int main(void) {       printf("Hello world!\n");       return 0;     }     ``` === "C++"     ``` c++     #include <iostream>

效果如图： docs/overrides下新建main.html ，针对main.html文件 树状结构如下: $ tree -a.├── .github│ ├── .DS_Store│ └── workflows│ └── PublishMySite.yml├── docs│ └── index.md│ └──overrides│

文章目录 1、简介2、安装3、创建新项目4、添加页面5、编辑导航页6、设置主题7、更改图标图标8、构建网站9、部署9.1 准备github项目9.2 注册登录Read the Docs9.3 导入github项目到 Read the Docs 10、Markdown语法10.1 横线10.2 标题10.3 段落10.4 文字高亮10.5 换行10.6 斜体、粗体、删除线10.7 引用10.8

官方文档：Adding a comment system 这里我同样推荐giscus 利用 GitHub Discussions 实现的评论系统，让访客借助 GitHub 在你的网站上留下评论和反应吧！本项目深受 utterances 的启发。 开源。🌏无跟踪，无广告，永久免费。📡 🚫无需数据库。所有数据均储存在 GitHub Discussions 中。:octocat:支持自定义主