The remote code block extension#

Documenteer provides a remote-code-block directive that works like literalinclude, but supports getting content from the web.

To use this directive, add the documenteer.sphinext.remotecodeblock extension to your conf.py file:

extensions = ["documenteer.sphinxext.remotecodeblock"]

Directive#

.. remote-code-block:: url#

Include content from url in a literal code block.

Example

.. remote-code-block:: https://raw.githubusercontent.com/lsst/templates/master/file_templates/stack_license_preamble_txt/template.txt.jinja
   :language: jinja

Result:

This file is part of {{ cookiecutter.package_name }}.

Developed for the LSST Data Management System.
This product includes software developed by the LSST Project
(https://www.lsst.org).
See the COPYRIGHT file at the top-level directory of this distribution
for details of code ownership.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.

Options

See the literalinclude documentation for available options.

The remote code block extension#

Directive#

Credit#