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.dev20240829070025
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.dev20240829070025.tar.gz | 20.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| litedoc-0.1.0.dev20240829070025-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 36.1 kB
Release files / litedoc-0.1.0.dev20240829070025.tar.gz
| Download URL | litedoc-0.1.0.dev20240829070025.tar.gz |
|---|---|
| Size | 20.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
13ac202368629471a4933c025d135a6b716ed571171c1e641ae39b68690bfefa
|
|
BLAKE2b-256 checksum How to use checksums |
40956e03b343a188fd5ccd837b13139dfbb0cfbdde485a70509ed0b5407417ba
|
| 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.dev20240829070025-py3-none-any.whl
| Download URL | litedoc-0.1.0.dev20240829070025-py3-none-any.whl |
|---|---|
| Size | 15.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1a4e5922496553c462bc197ed0fd97c576b8007237b8b36013556c49b5a33b51
|
|
BLAKE2b-256 checksum How to use checksums |
7fca289010b40566671de3f799e869a458f867aa9d73cc08bf05638c9d02dded
|
| 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
|
