仅文档网站

如何不使用库创建由 nbdev 驱动的文档！

背景

虽然 nbdev 非常适合编写软件，但您可能希望利用 nbdev 的强大功能来为现有代码编写文档，或者使用 nbdev 的各种实用程序而无需编写 Python 库。例如，您无需创建 Python 包即可使用 nbdev 的以下功能：

• 自定义 nbdev 指令，例如 #|hide_line。
• 使用 nbdev_test 进行测试。
• 使用 doclinks 进行自动化实体链接。
• 使用 docments 和 show_doc 渲染 API 文档。

设置

要设置一个仅文档网站，您可以按照以下步骤进行：

1. 按照通常的方式创建 nbdev 仓库，使用 nbdev_new
2. 移除库文件

rm setup.py .github/workflows/test.yaml nbs/00_core.ipynb

3. 移除您的库文件夹（这将是 settings.ini 文件中的 lib_path 字段）

rm -rf <lib_path>

用法

设置好项目后，您可以像往常一样使用 nbdev 的各种实用程序

• 使用 nbdev_preview 预览您的网站
• 使用 nbdev_test 在本地测试您的文档
• 自定义 nbdev 指令将可供您使用（但您必须小心不要使用不相关的指令，例如 #|export）。
• 如果您在 GitHub 上创建了 nbdev 文档网站，GitHub Actions 将自动为您发布文档，如此处所述。
• 您可以在其他平台上发布您的文档，如此处所述。

演示

一个最小的仅文档网站示例位于此处。