Skip to main content

Default template for PDM package

Project description

liteyuki-autodoc

为你的Python库模块生成清晰的markdown文档

功能:i18n支持,多风格注释支持,多主题支持

安装

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

在输出的目录下markdown文档是以模块原有的目录结构生成的,可以直接把输出内容移到目前主流的文档框架中,如VuePress,VitePress等,如果想优化用户体验,还可启用动态侧边栏

代码编写建议

  • 在编写库的时候,尽量写上标准的注释,这样对用户和自己都有好处
  • 生成器默认不处理"私有"变量和函数,即以_开头的变量和函数(尽管Python没有真正的私有变量),也默认不处理没有注释的变量
  • 如果你不想展示某个函数和变量,可以在函数文档字串任意处加上@litedoc-hide
  • 变量注释支持在同一行内使用#添加的注释,也支持在下一行使用"""注释内容"""添加的注释

示例项目

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

litedoc-0.1.0.dev20240829074319.tar.gz (21.7 kB view details)

Uploaded Source

Built Distribution

litedoc-0.1.0.dev20240829074319-py3-none-any.whl (16.4 kB view details)

Uploaded Python 3

File details

Details for the file litedoc-0.1.0.dev20240829074319.tar.gz.

File metadata

  • Download URL: litedoc-0.1.0.dev20240829074319.tar.gz
  • Upload date:
  • Size: 21.7 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

Hashes for litedoc-0.1.0.dev20240829074319.tar.gz
Algorithm Hash digest
SHA256 25a297183f9e19b3d98a0316b502da2771c0d68755c906a6f2f4d4e4e85344d5
MD5 384aa341bc3647509020f2ac446e24af
BLAKE2b-256 d1f4092518c5eaa48bd34141fc839e9694b551c2ce1da8b029ceb015a731d841

See more details on using hashes here.

File details

Details for the file litedoc-0.1.0.dev20240829074319-py3-none-any.whl.

File metadata

File hashes

Hashes for litedoc-0.1.0.dev20240829074319-py3-none-any.whl
Algorithm Hash digest
SHA256 609991c2fd6ae6a264c6a962f6283fe2ea721ea5f11e6b603d2789da2d36fd3a
MD5 94ddb63d71269ae9211417e073100f74
BLAKE2b-256 40d44f73d0ce2065b292af3201d3f3f2eeebe3d9ce5da77b96c962f574420464

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page