Skip to main content

Extending literalinclude to include remote URLs

Project description



Sphinx extension that extends the literalinclude directive to allow remote URLS


Please install the extension via pip using the following command:

python3 -m pip install sphinxext-remoteliteralinclude

then in your under extensions, it should look like the following:

extensions = ["sphinxext.remoteliteralinclude"]


Simply just use it as you normally would a normal literalinclude

.. rli::
   :language: java
   :lines: 10-29
   :lineno-start: 10

Important Notes

This is simply a modification of the normal literalinclude extension. Near all of the code is the exact same. Modifications are made by Eli Barnett, with pip module creation by Dalton Smith.

Using the extension to reference local files will not work. Use the regular literalinclude extension in that case.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for sphinxext-remoteliteralinclude, version 0.3.0
Filename, size File type Python version Upload date Hashes
Filename, size sphinxext_remoteliteralinclude-0.3.0-py3-none-any.whl (6.3 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size sphinxext-remoteliteralinclude-0.3.0.tar.gz (5.0 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page