flask-analysis
  • 简介
  • 序
  • 代码目录与详解
    • artwork目录
    • docs目录
    • examples目录
    • tests目录
    • 其他辅助文件
  • 主程序剖析
    • 短短几行 flask到底做了啥
    • 路由系统 为何如此简洁高效
    • 路由匹配探秘
    • 全局对象request解析
    • 全局对象g解析
    • 全局对象current_app解析
    • 全局对象session解析
    • flask特性之signal系统
    • flask特性之blueprint
    • flask特性之methodview
    • flask特性之配置系统
    • flask特性之模板系统
  • flask生态
    • 官方文档
    • 扩展推荐
    • 扩展开发
  • 推荐阅读
  • 贡献名单
Powered by GitBook
On this page

Was this helpful?

  1. 代码目录与详解

docs目录

Previousartwork目录Nextexamples目录

Last updated 5 years ago

Was this helpful?

从目录名中就可以知道，此目录是存放flask文档的位置，flask是利用rst格式进行书写的，可以利用sphinx生成清晰而且优美的文档，新版的python3 的文档就是有sphinx工具生成，同时，它已经以成为python项目中首选的文档工具，具体可参考sphink官方网站

可以看到docs目录中都是rst结尾的文件，我们称之为reStructuredText, 含义是”重新构建的文本”，也被称为RST或者是reST。reStructuredText是Python编程语言的Docutils项目的一部分，Python Doc-SIG(Documentation Special Interest Group)。该项目类似于Java的JavaDoc或者Perl的POD项目。Docutils能够从Python程序中提取注释和信息，格式化成程序文档。

.rst文件是轻量级标记语言的一种，被设计为容易阅读和编写的纯文本，并且可以借助Docutils这样的程序进行文档处理，也可以转换为HTML或者PDF等多种格式，或者由Sphinx-Doc这样的程序转换为LaTex、man等更多格式。

参考文档：

sphink
docutils
flask官方文档