【Python】mkdocs 生成帮助文档

1. 简介

MkDocs 是一个用于创建项目文档的 快速简单 , 完美华丽 的静态站点生成器. 文档源码使用 Markdown 来撰写, 用一个 YAML 文件作为配置文档.

官网文档:https://markdown-docs-zh.readthedocs.io/zh_CN/latest/

官方网站:https://www.mkdocs.org/

  

2. 需求

可以用于生成django-rest-framework离线文档,快速查看, 不依赖网速, 也可内网使用

3. 安装

pip install mkdocs

4. 查看帮助

$ mkdocs help
mkdocs [help|new|build|serve|gh-deploy] {options}

5. 创建项目

$ mkdocs new my-project
$ cd my-project

6. 运行项目

$ mkdocs serve
Running at: http://127.0.0.1:8000/

7. 打包项目

mkdocs build --clean

备注:

  因为django-rest-framework已经有docs目录, 直接打包即可

上一篇:pg 数据库不能使用 zh_CN.UTF-8:initdb: error: locale “zh_CN.UTF-8“ requires unsupported encoding “GBK“


下一篇:国际化异常:No message found under code 'xxx' for locale 'zh_CN' 解决办法