Toggle Light / Dark / Auto color theme

Toggle table of contents sidebar

Sphinx Doc - Include Code File

有的时候我们需要把代码文件原原本本的嵌入到 Sphinx Doc 文档中. 之所以我们不愿意 Copy and Paste 的原因大多是 “不想在两个地方维护同一份文档”, 而这个代码是需要运行测试是不是正确的, 所以不可能直接在 RestructuredText 中写.

这里最关键的 directive 是 literalinclude:

• https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-literalinclude