referencer-py

从您的公共API文档字符串生成markdown参考并将其添加到您的readme文件中。

功能

• 底层使用pydoc-markdown

入门

该软件包使用语义版本控制。这意味着主要版本可能包含破坏性更改。

$ pip install referencer

文档

referencer package README.md --in-place

API参考

cli

cli(package, document, **options)

命令行界面

Usage: referencer [OPTIONS] PACKAGE DOCUMENT

Options:
  --in-place               [default: False]
  --package-pattern TEXT   [default: from \.(\w+) import (\w+)]
  --document-section TEXT  [default: ## Reference]
  --version                Show the version and exit.
  --help                   Show this message and exit.

generate_document

generate_document(package, document, package_pattern='from \\.(\\w+) import (\\w+)', document_section='## API Reference')

生成文档

generate_reference

generate_reference(package, package_pattern='from \\.(\\w+) import (\\w+)')

生成参考

贡献

virtualenv .python -ppython3.7
source .python/bin/activate
make install
make test

变更日志

v0.x

• 初始版本