How to Document Lua Script

这个项目既然是学习笔记, 那么就应该有一个记笔记的规范. 在我看来, 学习代码的笔记最好的形式就是 Jupyter Notebook. 它既有代码, 又有文档, 还有输入输出. 这种交互式的学习方式可以大幅降低学习难度. 也方便以后回顾.

举例来说, 我们编写了下面这个 hello.lua 脚本. 首先我当然是按照 Lua Local Development Environment 中的方式本地开发调试. 调试完之后我就用 Sphinx Doc 中的 dropdown + literalincllude 来把源码嵌入到文档中.

hello.lua

#!/usr/bin/env lua

print("Hello World!")

然后再用下面这段小 Python 程序在 Jupyter Notebook 中执行 lua, 打印输出.

import subprocess

_ = subprocess.run(["lua", "hello.lua"])

Hello World!