sphinxext-remoteliteralinclude 0.6.1

Extending literalinclude to include remote URLs

sphinxext-remoteliteralinclude

Sphinx extension that extends the literalinclude directive to allow remote URLS

Installation

Please install the extension via pip using the following command:

python3 -m pip install sphinxext-remoteliteralinclude

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

extensions = ["sphinxext.remoteliteralinclude"]

Configuration

There are two optional configuration for retry logic for failed requests.

remoteliteralinclude_retry_time = 1.0
remoteliteralinclude_max_retry_time = 180.0

The retry_time is the base time in seconds to wait, with an exponential backoff until max_retry_time (in seconds) is reached.

Usage

Simply just use it as you normally would a normal literalinclude

.. rli:: 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.