openstack/openstack-manuals
Code Issues Proposed changes

Document the custom remote-code-block directive

Browse Source 
Change-Id: I8fdea3aa262e2b1e86849ba61195af6babefe2bf
This commit is contained in:
Gauvain Pocentek 2015-12-03 12:14:55 +01:00
parent 507548f85d
commit 1dff24428b
1 changed files with 44 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
doc/contributor-guide/source/rst-conv/source-code.rst
View File

@ -90,3 +90,47 @@ files, ``console`` for console inputs and outputs, and so on.
[DEFAULT] [DEFAULT]
# List of directories to load filter definitions from (separated by ','). # List of directories to load filter definitions from (separated by ',').
.. _remote-block:
Literal block using a remote file
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+-----------------+-----------------------------------------------------+
| **Directive** | ``remote-code-block`` |
+-----------------+-----------------------------------------------------+
| **Arguments** | ``python`` (default), ``ruby``, ``c``, ``console``, |
| | ``ini``, and others |
+-----------------+-----------------------------------------------------+
| **Options** | ``linenos``, ``emphasize-lines`` |
+-----------------+-----------------------------------------------------+
| **Description** | * Specifies the highlighting language directly. |
| | * Preserves line breaks and whitespaces. |
+-----------------+-----------------------------------------------------+
This directive behaves exactly like the ``code-block`` directive, but gets the
content from a remote URL (``http`` or ``https``).
``remote-code-block`` is a custom directive.
**Input**
.. code::
.. remote-code-block:: ini
http://git.openstack.org/cgit/openstack/nova/tree/etc/nova/api-paste.ini?h=stable/liberty
**Output**
.. code-block:: ini
############
# Metadata #
############
[composite:metadata]
use = egg:Paste#urlmap
/: meta
[pipeline:meta]
pipeline = cors ec2faultwrap logrequest metaapp