跳转到主要内容

扩展literalinclude以包括远程URL

项目描述

sphinxext-remoteliteralinclude

CI

Sphinx扩展,扩展了literalinclude指令以允许远程URL

安装

请使用以下命令通过pip安装扩展

python3 -m pip install sphinxext-remoteliteralinclude

然后在您的conf.py下的extensions中,它应该看起来像以下这样

extensions = ["sphinxext.remoteliteralinclude"]

用法

只需像使用正常的literalinclude一样使用它即可

.. rli:: https://example.com/example.java
   :language: java
   :lines: 10-29
   :linenos:
   :lineno-start: 10

重要注意事项

这只是对正常的literalinclude扩展进行了修改。大部分代码都是完全相同的。修改由Eli Barnett完成,pip模块创建由Dalton Smith完成。

使用扩展引用本地文件将不会工作。在这种情况下,请使用常规的 literalinclude 扩展。

项目详情


下载文件

下载适合您平台的文件。如果您不确定选择哪个,请了解更多关于 安装包 的信息。

源分发

sphinxext-remoteliteralinclude-0.4.0.tar.gz (5.2 kB 查看散列)

上传时间

构建分发

sphinxext_remoteliteralinclude-0.4.0-py3-none-any.whl (6.4 kB 查看散列)

上传时间 Python 3