的最小python API文档生成https://mathy.ai
mathy-pydoc的Python项目详细描述
马蒂安·皮多克
IMPORTANT这是pydoc_markdown repo的一个分支，它使用遗留版本来满足Mathy的简单API-doc需求。有关最新的稳定更新，请参见官方回购：https://github.com/NiklasRosenstein/pydoc-markdown
–，由[Keras]文档
安装
pip install mathy_pydoc
使用
mathy_pydoc使用
mathy_pydoc命令。在命令行上指定一个或多个模块名称。
支持+语法来包含模块的成员（或者++来包含）
成员成员等）
语法
交叉引用
可以使用哈希符号（#）引用同一命名空间中的符号
后面直接跟符号的名称，包括相关引用。请注意
建议使用括号作为函数名，并将忽略和
转换docstrings时自动添加。示例：#ClassName.member或
#mod.function()。在
对于名称不可用的模块或成员的绝对引用
在当前全局命名空间中，必须使用#::mod.member（注意这两个
前两个双冒号）。在
对于只显示名称的一部分的长引用名称，
可以使用语法#X~some.reference.name，其中X是
要保留的元素。如果省略X，则假定为1。例子：
#~some.reference.name只显示name。在
以附加实际中未包含的附加字符
引用名，可以使用另一个哈希符号，如#Signal#s。在
截面
节可以使用Markdown# <Title>语法生成。这很重要
在哈希符号（#）后添加一个空格，否则它将表示
交叉引用。某些特殊部分会更改其渲染结果
内容，包括
- 参数（1）
- 参数（1）
- 属性（1）
- 成员（1）
- 加薪（2）
- 退货（2）
（1）：以<ident> [(<type>[, ...])]:开头的行被视为
参数/参数或属性/成员声明。中列出的类型
如果可能，括号（可选）是交叉链接的。属性/成员
声明时，标识符以等宽字体键入。在
（2）：以<type>[, ...]:开头的行被视为raise/return类型
如果可能，声明和类型名是交叉链接的。在
名称描述后面的行被认为是最新的
除非用另一个声明或空行分隔。<type>
占位符也可以是(<type>[, ...])形式的元组。在
代码块
可以使用带有语言注释的GitHub样式的降价代码块。在
```python
>>> for i in range(100):
...
```
- 项目
标签：
欢迎加入QQ群-->： 979659372
