Default template for PDM package
Project description
liteyuki-autodoc
为你的Python模块生成markdown文档
支持i18n,Google Style,Numpy Style,reStructuredText Style(待支持)
安装
pip install litedoc
使用
python -m litedoc <your_module_path> -o|--output <output_path>
详细参数
-o|--output: "doc-output" 输出路径,默认为doc-output
-l|--lang: "zh-Hans" 语言,支持en, zh-Hans,zh-Hant,ja等,默认zh-Hans
-t|--theme: "vitepress" 主题,支持vitepress, vuepress, 默认vitepress
-s|--style: "google" 风格,支持google, numpy, reStructuredText, 默认google,但目前只实现了google,欢迎PR
-c|--contain-top #是否包含顶部文件夹信息,即在输出目录再套一层module_path的basedir
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for litedoc-0.1.0.dev20240829072154.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ad3ff2f87d1808e86229590b31eb9465e1e7a886fee745d59be04277b3c29672 |
|
MD5 | 59fc0e453b25a3187ebd47eca4a36c20 |
|
BLAKE2b-256 | fef7ed835a076c4f0f43a52686a1a008ad6e63a1a6a3da6062a8768d1777d6d5 |
Close
Hashes for litedoc-0.1.0.dev20240829072154-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d2400aa5f6b859b1373106587f6e8a4a2b5fcd4772fe87da5b517309bbf82dd1 |
|
MD5 | ee6bba3364101a9e9b4d302f150b7dc2 |
|
BLAKE2b-256 | f0eb65a2734bdc4e31fa73f4a76c3ce0d642dbc0dd1682a7cdaeda414e0530a3 |