从文档字符串中解开特殊的降价块并将它们组装成一个静态网页。
项目描述
文档注释解开器
一个小工具，用于从文档字符串中提取特殊块并将它们嵌入到静态网页中。
请参阅此处的示例。
动机
从长远来看，好的文档可能是无价的，但它需要付出努力，这在短期内很难证明是合理的。并非所有项目都是扩展库或框架，它们通常只是具有几个关键业务逻辑的小型应用程序。在这些情况下，尤其是放弃外部文档可能很诱人，当涉及到新人入职或不得不一遍又一遍地向利益相关者解释特定行为时，这当然会反击你。
我们有很多工具可以从专用文件构建和托管静态页面和 wiki，但是在记录业务逻辑时，它们需要高度警惕以避免文档和实际行为之间的差异。误导性文档通常比没有文档更糟糕。
为了避免随着时间的推移累积差异，将您的文档放在代码本身附近会有所帮助，这样修改它的工程师可以快速发现文档中的新错误并修复它们。
模块、类和函数文档字符串是此类文档的好地方，并且此工具可让您轻松定义其中的哪些部分可能与外部用户相关并为它们生成静态页面。
细节
何时不使用此工具：
- 您正在记录库、框架或复杂的应用程序
- 您正在为您的 api 生成参考手册
当您可能想要使用此工具时：
- 您的应用程序包含一些应该在外部记录的逻辑
用法
python -m doc_note_untangler.cli <directory>
例子
从这个项目中提取的笔记托管在github pages上。您将在源代码中找到相关的文档字符串。
配置
CLI 应用程序提供了一些基本配置，例如设置源路径和输出目录。查看python -m doc_note_untangler.cli --help所有选项。
如果您需要更复杂的定制，请将源代码复制粘贴到您自己的项目中并随意修改。
关
doc_note_untangler -1.0.1.tar.gz 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 7bdd05fb7b85636ef9770fd3efeac63f7c4b76454ec4f7b5d97890eddc0f14e8 |
|
| MD5 | 3a824d117902f0905c8cf4c9e472b573 |
|
| 布莱克2-256 | 425d45708ec163775b9f06591e13d1f157ca620b4abc8df08ef06e7b69ff62a0 |
关
doc_note_untangler -1.0.1-py3-none-any.whl 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | a80ec1a368fe1259916e4170e27abfe042af3a037f073abaa580805e09392e4e |
|
| MD5 | 0cf4b32a71e9df52529c8429dd4105a4 |
|
| 布莱克2-256 | d64f774ec172184342e7a6582341a6477fc47f89db5b09ee699b1a885d0fa05c |