sphinx-examples

一个小型的Sphinx扩展，用于创建源标记示例及其在文档中渲染的结果。如果您想在Sphinx中演示新指令或角色的功能，这很有用。

🚨 这是一个非常早期的软件🚨：它主要为了方便而打包，并没有经过严格的测试。使用风险自负！

安装

您可以使用pip安装sphinx-examples

pip install sphinx-examples

使用

更多信息请参阅 sphinx-examples 文档

开发

要开发此扩展，请按照以下步骤进行

1. 在本地克隆仓库

   $ git clone https://github.com/executablebooks/sphinx-examples
   $ cd sphinx-examples
   

2. 安装预提交钩子

   $ pre-commit install
   

3. 安装开发和文档依赖项

   $ pip install -e .[sphinx]
   

此包的代码库位于 src/sphinx_examples。文档位于 docs/。

此包没有测试基础设施，因此使用时请小心！如果它变得更加复杂或增加了更多功能，我们可能在将来添加更多测试。目前它是为了方便在EBP仓库之间重用而打包的。

构建文档

文档目前尚未托管在任何地方，因此如果您想预览“实时”文档，请运行以下命令

pip install -e .[sphinx]
sphinx-build docs docs/_build/html

然后浏览 docs/_build/html 中的HTML文件，以查看渲染的文档。

灵感

此项目大量借鉴了Bootstrap v5 文档。