Skip to main content

Default template for PDM package

Project description

Litedoc

为你的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
  • 变量注释支持在同一行内使用#添加的注释,也支持在下一行使用"""注释内容"""添加的注释

自动化构建(Github workflows)

  • 如果你了解并正在使用github workflow自动构建文档,那么可以把生成API markdown的步骤也添加进去,无需手动生成文档。
  • 需在构建静态页面之前生成API markdown
...
      - name: Set up Python
        uses: actions/setup-python@v2
        with:
          python-version: '3.10'


      - name: Build API markdown
        run: |-
          python -m pip install litedoc
          python -m litedoc <your_module> -o docs/dev/api -l zh-Hans -t vuepress
          python -m litedoc <your_module> -o docs/en/dev/api -l en -t vuepress'   # 请自行更改这部分
...
# build your static page

示例项目

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

Uploaded Source

Built Distribution

litedoc-0.1.0.dev20240829105018-py3-none-any.whl (16.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: litedoc-0.1.0.dev20240829105018.tar.gz
  • Upload date:
  • Size: 22.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.dev20240829105018.tar.gz
Algorithm Hash digest
SHA256 934a101a949cfd3a1457b19d9a5314a9d6980d6ea214792942cb7c59c292e002
MD5 9de0f8e4cef44144af134f80e8d40608
BLAKE2b-256 00172476a37ab81d5786918af90fbedd048f363cc935eaefd65a7b5ee67ce88e

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for litedoc-0.1.0.dev20240829105018-py3-none-any.whl
Algorithm Hash digest
SHA256 9fb532858bef14eb6f93b8b6bb0401fdb8f1ca1f646ebe21f09689d474ffcdba
MD5 1e90de7b7a2c4521f045525bdd629abc
BLAKE2b-256 42df94e7cd7db34f452f9424cbfbbf457fed77dd6219a329625e741dc15354c0

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