Extending literalinclude to include remote URLs
Project description
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"]
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.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file sphinxext-remoteliteralinclude-0.4.0.tar.gz
.
File metadata
- Download URL: sphinxext-remoteliteralinclude-0.4.0.tar.gz
- Upload date:
- Size: 5.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.13
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4db25a23c04e09560cbe5e0787b0263305e3f3282a2396945ef5c04c1bb97a33 |
|
MD5 | 3677be4168281dfbb0dfa6f458db8ce7 |
|
BLAKE2b-256 | a965a2a09c0943b14540f7c19fd531781a16131ca1bab11f89949864f74530cc |
File details
Details for the file sphinxext_remoteliteralinclude-0.4.0-py3-none-any.whl
.
File metadata
- Download URL: sphinxext_remoteliteralinclude-0.4.0-py3-none-any.whl
- Upload date:
- Size: 6.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.13
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | e91378f07f378e6ca435246e07334c19a8c16b9baf6e180fc3e428a359846ea2 |
|
MD5 | aa507051711797e49ba262521e115601 |
|
BLAKE2b-256 | 130d7e5009f48c33d5fd533dda80b42c4a79fce8dfdd1b617d0a9df9a9836145 |