Skip to main content

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 git+https://github.com/daltz333/sphinxcontrib-remoteliteralinclude

Usage

Simply just use it as you normally would a normal literalinclude

.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/master/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/templates/commandbased/commands/ExampleCommand.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 sphinxcontrib-remoteliteralinclude-0.0.2.tar.gz.

File metadata

  • Download URL: sphinxcontrib-remoteliteralinclude-0.0.2.tar.gz
  • Upload date:
  • Size: 4.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.7.3

File hashes

Hashes for sphinxcontrib-remoteliteralinclude-0.0.2.tar.gz
Algorithm Hash digest
SHA256 f48c8fe8a38973975253155f11568231871f8ae13e3cdfe0d00a6f4f9f29e425
MD5 bef5684ebcb1e3da2dd8efbcb9d25188
BLAKE2b-256 1c2cd928ba07cc7a24eb2fc4c30a6c2cb4b44aad2aa143a4d0122e1ed5f57a65

See more details on using hashes here.

File details

Details for the file sphinxcontrib_remoteliteralinclude-0.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinxcontrib_remoteliteralinclude-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 1408fc1382b316a1bb06519bd69be0d45d2f1f2b5653629777742fd6a5a0ef41
MD5 e889b7412b248564cec122dd46f13214
BLAKE2b-256 5f8e8aeec76ee2c267b907828cffd26d8a5c48cde450c55d17057e3513fa0394

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page