Docdocdoc

一个从docstrings模板文档的Python库。

安装

您可以使用以下命令使用pip安装docdocdoc：

pip install docdocdoc

用法

• build
  • build_fn
  • build_toc
  • build_docs
  • generate_readme
• parts
  • assembling_description
  • get_article
  • get_function
  • get_references
  • template_params
  • template_references
  • template_return

build

build_fn

返回使用Markdown编写的函数或类文档的函数。

参数

• fn str - 函数或类名的字符串。

返回

str - 使用Markdown编写的函数或类文档。

build_toc

返回使用Markdown编写的目录表的函数。

参数

• data list - 包含键 "title" 和 "fns" 的字典列表。 "title" 包含节名，"fns" 包含节中的函数名。

返回

str - 使用Markdown编写的目录表。

build_docs

返回使用Markdown编写的文档的函数。

参数

• data list - 包含键 "title" 和 "fns" 的字典列表。 "title" 包含节名，"fns" 包含节中的函数名。

返回

StringIO - 使用Markdown编写的文档。

generate_readme

打印readme的函数。

参数

• data list - 包含键 "title" 和 "fns" 的字典列表。 "title" 包含节名，"fns" 包含节中的函数名。

parts

assembling_description

返回docstring的简短描述，与长描述聚合。

参数

• docstring DocstringStyle.GOOGLE - 一个Google docstring。

返回

string - docstring的描述。

get_article

如果docstring有一个文章，则返回文章，否则返回None。

参数

• docstring DocstringStyle.GOOGLE - 一个Google docstring。

返回

string - 包含文章描述的字符串。

get_function

返回一个包含函数（或类）文档的不同部分（即名称、描述、文章）的字典。

参数

• fn function - 您定义的函数。

返回

dict - 包含文档的不同部分的字典。

get_references

函数返回文档字符串中存在的引用，否则返回 None。

参数

• docstring DocstringStyle.GOOGLE - 一个Google docstring。

返回

列表 - 包含引用字符串的列表。

template_params

函数返回模板参数。

参数

• fn_doc 字典 - 包含函数文档部分的字典（由 get_function 返回）。

返回

字符串 - 模板参数。

template_references

函数返回模板引用。

参数

• fn_doc 字典 - 包含函数文档部分的字典（由 get_function 返回）。

返回

字符串 - 模板引用。

template_return

函数返回模板参数。

参数

• fn_doc 字典 - 包含函数文档部分的字典（由 get_function 返回）。

返回

字符串 - 模板返回值。