https://github.com/wpilibsuite/sphinxext-remoteliteralinclude
Extends literalinclude to include URLs
https://github.com/wpilibsuite/sphinxext-remoteliteralinclude
sphinx-extension
Last synced: 5 months ago
JSON representation
Extends literalinclude to include URLs
- Host: GitHub
- URL: https://github.com/wpilibsuite/sphinxext-remoteliteralinclude
- Owner: wpilibsuite
- License: other
- Created: 2019-09-06T18:21:06.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-11-21T21:15:55.000Z (6 months ago)
- Last Synced: 2024-12-09T22:43:49.548Z (6 months ago)
- Topics: sphinx-extension
- Language: Python
- Homepage:
- Size: 21.5 KB
- Stars: 14
- Watchers: 9
- Forks: 5
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# 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:
```python
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.