为https://mathy.ai提供最简单的Python API文档生成工具
项目描述
mathy_pydoc
重要 这是从pydoc_markdown存储库派生出来的，用于Mathy的简单API文档需求。有关最新稳定更新的官方存储库，请参阅：https://github.com/NiklasRosenstein/pydoc-markdown
– 受[Keras]文档的启发
安装
pip install mathy_pydoc
使用
mathy_pydoc使用mathy_pydoc命令从Python模块生成纯Markdown文件。在命令行上指定一个或多个模块名称。支持使用+语法来包括模块的成员（或使用++来包括成员的成员等。）
mathy_pydoc mypackage+ mypackage.mymodule+ > docs.md
语法
交叉引用
在同一命名空间中的符号可以通过使用紧跟符号名称的井号符号（#）进行引用，包括相对引用。请注意，鼓励使用括号来表示函数名称，将在转换文档字符串时忽略，并自动添加。例如：#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>[, ...]: 开头的行被视为引发/返回类型声明，并且如果可能的话，类型名称可以交叉链接。
名称描述之后的行被视为最新文档的一部分，除非有另一个声明或空行将其分开。 <type> 占位符也可以是形式为 (<type>[, ...]) 的元组。
代码块
可以使用带语言注释的 GitHub 风格 Markdown 代码块。
```python
>>> for i in range(100):
...
```
下载文件
下载您平台上的文件。如果您不确定选择哪个，请了解有关 安装包 的更多信息。
源分布
构建分布
mathy_pydoc-0.7.30.tar.gz 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 81c32a76195ae01df1c900c0513f62ea0a943df2a23d80097ceb39a9ca93a22a |
|
| MD5 | 095590057678e9bcc53f1e4f6fb50d19 |
|
| BLAKE2b-256 | 8414bf088e5c469ebf835c1e579cc33971e6524466520935b00be3295b545a41 |
mathy_pydoc-0.7.30-py3-none-any.whl 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | b3b7950c7e30ca363f811a985bd5ed868b35499b482cdff82ae353fd9d818148 |
|
| MD5 | db54d981052f69abbb637891a96e0279 |
|
| BLAKE2b-256 | 7411d229bc462ed116324d4792e0302beb2f121c10d7b5f452d6d87943a54d85 |
