Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Extending literalinclude to include remote URLs

Project description

sphinxcontrib-remoteliteralinclude

Sphinx extension that extends the literalinclude directive to allow remote URLS

Installation

python3 -m pip install sphinxcontrib-remoteliteralinclude

Usage

Simply just use it as you normally would a normal literalinclude

.. remoteliteralinclude:: https://example.com/example.java
   :language: java
   :lines: 10-29
   :linenos:
   :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 sphinxcontrib-remoteliteralinclude, version 0.0.3
Filename, size File type Python version Upload date Hashes
Filename, size sphinxcontrib-remoteliteralinclude-0.0.3.tar.gz (4.4 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page