使用Quarto生成API文档。
项目描述
概览
quartodoc 允许您使用Markdown和Quarto快速生成Python包API参考文档。quartodoc旨在作为Sphinx的替代品。
查看下面的屏幕录像，了解创建文档站点的步骤，或继续阅读说明。
安装
python -m pip install quartodoc
或从GitHub
python -m pip install git+https://github.com/machow/quartodoc.git
安装Quarto
如果您还没有安装，您需要先安装Quarto，然后才能使用quartodoc。
基本使用
开始使用quartodoc需要两个步骤：配置quartodoc，然后为您的库生成文档页面。
您可以将 quartodoc 配置与 Quarto 网站的其余部分一起在您已经用于 Quarto 的 _quarto.yml 文件中。要配置 quartodoc，您需要在您的 _quarto.yml 文件顶级添加一个 quartodoc 部分。以下是一个配置 quartodoc 包的示例：
project:
type: website
# tell quarto to read the generated sidebar
metadata-files:
- _sidebar.yml
quartodoc:
# the name used to import the package you want to create reference docs for
package: quartodoc
# write sidebar data to this file
sidebar: _sidebar.yml
sections:
- title: Some functions
desc: Functions to inspect docstrings.
contents:
# the functions being documented in the package.
# you can refer to anything: class methods, modules, etc..
- get_object
- preview
配置 quartodoc 后，您可以使用以下命令生成参考 API 文档
quartodoc build
这将创建一个包含 index.qmd 和列出函数的文档页面，如 get_object 和 preview 的 reference/ 目录。
最后，使用 Quarto 预览您的网站
quarto preview
重建网站
您可以使用以下命令预览您的 quartodoc 网站
首先，监视您正在记录的库中的更改，以便您的文档将自动重新生成
quartodoc build --watch
其次，预览您的网站
quarto preview
查找对象
为 Python 对象生成 API 参考文档涉及两部分的配置
- 包名称。
- 内容对象列表。
quartodoc 可以查找各种对象，包括函数、模块、类、属性和方法
quartodoc:
package: quartodoc
sections:
- title: Some section
desc: ""
contents:
- get_object # function: quartodoc.get_object
- ast.preview # submodule func: quartodoc.ast.preview
- MdRenderer # class: quartodoc.MdRenderer
- MdRenderer.render # method: quartodoc.MDRenderer.render
- renderers # module: quartodoc.renderers
contents 中列出的函数假定已从包中导入。
了解更多信息
前往 下一页 了解如何配置 quartodoc 网站，或查看以下实用页面
- 示例页面：使用 quartodoc 的网站。
- 教程页面：构建 quartodoc 网站的屏幕录制。
- 文档字符串问题和示例：格式化文档字符串时的常见问题。
- 编程，大图景：quartodoc 的工作细节以及如何扩展它。
下载文件
下载您平台上的文件。如果您不确定选择哪个，请了解更多关于 安装包 的信息。
源分发
quartodoc-0.7.6.tar.gz (768.3 kB 查看哈希值)
构建分发
quartodoc-0.7.6-py3-none-any.whl (79.8 kB 查看哈希值)