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
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file litedoc-0.1.0.dev20240829065530.tar.gz.
File metadata
- Download URL: litedoc-0.1.0.dev20240829065530.tar.gz
- Upload date:
- Size: 20.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: pdm/2.18.1 CPython/3.10.12 Linux/6.5.0-1025-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
69a62a4a3e4b87ccb6126f4b1cb3c9a2811d33ca479ac84521b4541c02f39ff8
|
|
| MD5 |
72b07858add58a4358cecbae1fc81bd5
|
|
| BLAKE2b-256 |
98162ae20296bbcc7c31820c3ae423ea89419454c209824a767c3a9af2c1ec45
|
File details
Details for the file litedoc-0.1.0.dev20240829065530-py3-none-any.whl.
File metadata
- Download URL: litedoc-0.1.0.dev20240829065530-py3-none-any.whl
- Upload date:
- Size: 15.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: pdm/2.18.1 CPython/3.10.12 Linux/6.5.0-1025-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cf04ceac34fb005979d05fd0c093035650233a09d9e7d112585c8c9cdcfb0890
|
|
| MD5 |
3a5f58e87fd80b27cee62bdceef846f4
|
|
| BLAKE2b-256 |
2de49ccfea91ba441636d18732d194cfd2ab49d3c89de52acf7ea670cec00fe3
|
