File: README.rst

package info (click to toggle)
sphinx-autorun 1.1.0-3.1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, sid
  • size: 136 kB
  • sloc: makefile: 160; python: 152
file content (67 lines) | stat: -rw-r--r-- 1,281 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
==============
sphinx-autorun
==============

sphinx-autorun is an extension for Sphinx_ that can execute the code from a
runblock directive and attach the output of the execution to the document. 

.. _Sphinx: https://sphinx.readthedocs.io/

For example::

    .. runblock:: pycon
        
        >>> for i in range(5):
        ...    print i

Produces::

    >>> for i in range(5):
    ...    print i
    1
    2
    3
    4
    5


Another example::

    .. runblock:: console

        $ date

Produces::

    $ date 
    Thu  4 Mar 2010 22:56:49 EST

Currently autorun supports ``pycon`` and ``console`` languages. It's also
possible to configure autorun (from `conf.py`) to run other languages.


Installation
------------

Installing via pip (recommended)::

    $ pip install sphinx-autorun

Install from source::

    $ git clone git@github.com:hobarrera/sphinx-autorun.git
    $ python setup.py install

To enable autorun add 'sphinx_autorun' to the ``extension`` list in
`conf.py`::

    extensions.append('sphinx_autorun')

The documentation is in the doc/ folder.

About this fork
---------------

sphinx-contrib/autorun was abandoned and broken for several months. Since it
did not even work, this fork was created as a continuation of it with mostly
critical fixes.