Pre-release
This release is a pre-release and may not be stable for production use.
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
1 maintainer
Metadata
1 maintainer
Release files for litedoc 0.1.0.dev20240829072326
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| litedoc-0.1.0.dev20240829072326.tar.gz | 20.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| litedoc-0.1.0.dev20240829072326-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 36.3 kB
Release files / litedoc-0.1.0.dev20240829072326.tar.gz
| Download URL | litedoc-0.1.0.dev20240829072326.tar.gz |
|---|---|
| Size | 20.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
08fcf713e399b7a185f04dc109ad5f44f7ae63f807ab51cde6dbb14e8d52d140
|
|
BLAKE2b-256 checksum How to use checksums |
2acbb2c235bcef142e83c6a4ccd0e0d0b10450ad738b045ca1436c039715cbe5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
pdm/2.18.1 CPython/3.10.12 Linux/6.5.0-1025-azure
|
Release files / litedoc-0.1.0.dev20240829072326-py3-none-any.whl
| Download URL | litedoc-0.1.0.dev20240829072326-py3-none-any.whl |
|---|---|
| Size | 15.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
75e401f06739951cb72659c97f89d33c763f5e24310ee7b1ed09c8e4e9b90786
|
|
BLAKE2b-256 checksum How to use checksums |
271bffa641c87b2afc4bb13753d439d93623506bb51f4567617c94c048dbd99f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
pdm/2.18.1 CPython/3.10.12 Linux/6.5.0-1025-azure
|
