Skip to main content

Petlja 用于学习内容的命令行界面

项目描述

PetljaDoc - Petlja 的电子学习内容工具

该工具基于https://github.com/RunestoneInteractive/RunestoneComponentshttps://github.com/sphinx-doc/sphinx,包括:

  • 额外的 Sphinx 扩展
  • Sculpt 的部分 Pygame 实现(https://github.com/Petlja/pygame4skulpt
  • 其他 ActiveCode 功能
  • 自定义狮身人面像主题
  • 自定义项目模板
  • 扩展在线课程格式
  • petljadoc命令行界面 (CLI)

PetljaDoc 目前依赖于分叉的 RunestoneComonents,但我们正在通过拉取请求逐渐缩小与上游存储库的差距。

安装

用于pipPetljaDoc install

pip3 install petljadoc

如果您使用 Windows 并且之前的命令不起作用,请尝试:

py -3 -m pip install petljadoc

命令行使用

petljadoc [OPTIONS] COMMAND [ARGS]...

选项:

  • --help    显示帮助信息

命令:

  • init-course    在当前目录中创建一个新的在线课程项目
  • init-runestone    在当前目录中创建一个新的 Runestone 项目
  • preview    构建项目,在网络浏览器中打开它,观察更改,重建更改的文件并在重建后刷新浏览器(使用sphinx-autobuild
  • publish    构建项目并将生成的内容复制到docs子文件夹中(准备好使用 GitHub Pages 发布)

通过使用petljadoc preview,作者可以保持打开浏览器窗口进行预览。任何保存的更改将在大约 5-10 秒后在浏览器中更新。

petljadoc publish命令可帮助作者通过 GitHub Pages 共享其作品的公开预览。

项目详情


发布历史 发布通知| RSS订阅