Metadata-Version: 2.0
Name: remotecode
Version: 0.1.0
Summary: A Sphinx extension that enables remote code blocks
Home-page: https://github.com/kallimachos/remotecode
Author: Brian moss
Author-email: kallimachos@gmail.com
License: GPLv3
Keywords: sphinx documentation remote code block
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Documentation :: Sphinx
Classifier: Framework :: Sphinx :: Extension
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Requires-Dist: requests

==========
remotecode
==========

.. image:: https://travis-ci.org/kallimachos/remotecode.svg?branch=master
   :target: https://travis-ci.org/kallimachos/remotecode

.. image:: https://img.shields.io/pypi/status/remotecode.svg?style=flat
   :target: https://pypi.python.org/pypi/remotecode

.. image:: https://img.shields.io/pypi/v/remotecode.svg?style=flat
   :target: https://pypi.python.org/pypi/remotecode

.. image:: https://img.shields.io/badge/Python-2.7-brightgreen.svg?style=flat
   :target: http://python.org

.. image:: https://img.shields.io/badge/Python-3.4-brightgreen.svg?style=flat
   :target: http://python.org

.. image:: http://img.shields.io/badge/license-GPL-blue.svg?style=flat
   :target: http://opensource.org/licenses/GPL-3.0

**remotecode** is an extension for Sphinx that enables code blocks from
remote sources.

Full documentation: https://kallimachos.github.io/remotecode/


Installation
~~~~~~~~~~~~

Install **remotecode** using ``pip``:

.. code::

   $ pip install remotecode


Usage
~~~~~

#. Add **remotecode** to the list of extensions in ``conf.py``:

   .. code::

      extensions = ['remotecode']

#. Use the ``remote-code-block`` directive to fetch remote source code and display it
   in a ``code-block``.

   .. code::

      .. remote-code-block:: ini

         https://example.com/rawsource.ini


