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
代码编写小提示
- 生成器默认不处理"私有"变量和函数，即以
_开头的变量和函数（尽管Python没有真正的私有变量），也默认不处理没有类型注释的变量 - 如果你不想展示某个函数和变量，可以在函数文档字串任意处加上
@litedoc-hide - 变量注释支持在同一行内使用
#添加的注释，也支持在下一行使用"""注释内容"""添加的注释
示例项目
1 maintainer
Metadata
1 maintainer
Release files for litedoc 0.1.0.dev20240829073717
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.dev20240829073717.tar.gz | 21.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| litedoc-0.1.0.dev20240829073717-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 37.4 kB
Release files / litedoc-0.1.0.dev20240829073717.tar.gz
| Download URL | litedoc-0.1.0.dev20240829073717.tar.gz |
|---|---|
| Size | 21.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c35674256f240c5f94dd6232b3ebf1f66072cde0138b213030f1a3c83651748a
|
|
BLAKE2b-256 checksum How to use checksums |
419ae3da8da3a424a2a3f499fbbd7aa7f5f95da1906d73f0327139091a5a3e25
|
| 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.dev20240829073717-py3-none-any.whl
| Download URL | litedoc-0.1.0.dev20240829073717-py3-none-any.whl |
|---|---|
| Size | 16.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6369989b3795d48db43a133578f35e5752194674d600537281743f84ca4e90e1
|
|
BLAKE2b-256 checksum How to use checksums |
e390991699265e2c423d0b63c5d2b75541dda12da41636ba7d61c0a0512dce90
|
| 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
|
