文件名称：mkautodoc:MkDocs的自动文档:blue_book:
文件大小：10KB
文件格式：ZIP
更新时间：2024-05-28 09:11:06
Python
MkAutoDoc MkDocs的Python API文档。 此markdown扩展添加了自动autodoc样式支持，可与MkDocs一起使用。 用法 1.在您的mkdocs.yml配置文件中包含扩展名： [...] markdown_extensions : - admonition - codehilite - mkautodoc 2.确保要记录的库是可导入的。 这将取决于文档建立的设置方式，但是您可能需要使用pip install -e . 或在您的文档构建脚本中修改PYTHONPATH 。 3.使用:::块语法将autodoc块添加到您的文档中。 # API documentation ::: my_library.some_function :docstring: ::: my_library.SomeClass :docstring:
【文件预览】：
mkautodoc-master
----setup.py(1KB)
----.gitignore(54B)
----requirements.txt(44B)
----mkautodoc()
--------__init__.py(131B)
--------extension.py(9KB)
----.travis.yml(151B)
----scripts()
--------publish(647B)
--------install(263B)
--------clean(232B)
--------lint(150B)
--------test(297B)
----README.md(2KB)
----tests()
--------__init__.py(0B)
--------test_extension.py(3KB)
--------mocklib()
--------assertions.py(2KB)