Metadata-Version: 2.4
Name: sphinxext-remoteliteralinclude
Version: 0.6.1
Summary: Extending literalinclude to include remote URLs
Home-page: https://github.com/wpilibsuite/sphinxext-remoteliteralinclude
Author: Eli Barnett, Dalton Smith
Author-email: daltzsmith@gmail.com
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Plugins
Classifier: Environment :: Web Environment
Classifier: Framework :: Sphinx :: Extension
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Text Processing
Classifier: Topic :: Utilities
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: sphinx>=4.3; python_version >= "3.10"
Requires-Dist: six
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license-file
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# sphinxext-remoteliteralinclude

![CI](https://github.com/wpilibsuite/sphinxext-remoteliteralinclude/workflows/CI/badge.svg)

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:

```python
extensions = ["sphinxext.remoteliteralinclude"]
```

## Configuration

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

```python
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.
