Skip to main content

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

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.dev20240829070025.tar.gz (20.3 kB view details)

Uploaded Source

Built Distribution

litedoc-0.1.0.dev20240829070025-py3-none-any.whl (15.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: litedoc-0.1.0.dev20240829070025.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

Hashes for litedoc-0.1.0.dev20240829070025.tar.gz
Algorithm Hash digest
SHA256 13ac202368629471a4933c025d135a6b716ed571171c1e641ae39b68690bfefa
MD5 8d2c790741f39c9f944544f262d7d6e8
BLAKE2b-256 40956e03b343a188fd5ccd837b13139dfbb0cfbdde485a70509ed0b5407417ba

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for litedoc-0.1.0.dev20240829070025-py3-none-any.whl
Algorithm Hash digest
SHA256 1a4e5922496553c462bc197ed0fd97c576b8007237b8b36013556c49b5a33b51
MD5 57cdc0a081426a8e858dad7a04b9c87e
BLAKE2b-256 7fca289010b40566671de3f799e869a458f867aa9d73cc08bf05638c9d02dded

See more details on using hashes here.

Provenance

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