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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
|
Testing downloadable files
==========================
Download :download:`img.png` here.
Download :download:`this <subdir/img.png>` there.
Download :download:`file with special characters <file_with_special_#_chars.xyz>`.
Test file and literal inclusion
===============================
.. include:: subdir/include.inc
.. include:: /subdir/include.inc
.. literalinclude:: literal.inc
:language: python
.. should succeed
.. literalinclude:: wrongenc.inc
:encoding: latin-1
:language: none
.. include:: wrongenc.inc
:encoding: latin-1
Literalinclude options
======================
.. highlight:: text
.. cssclass:: inc-pyobj1
.. literalinclude:: literal.inc
:pyobject: Foo
.. cssclass:: inc-pyobj2
.. literalinclude:: literal.inc
:pyobject: Bar.baz
.. cssclass:: inc-lines
.. literalinclude:: literal.inc
:lines: 6-7,9
:lineno-start: 6
.. cssclass:: inc-startend
.. literalinclude:: literal.inc
:start-after: coding: utf-8
:end-before: class Foo
.. cssclass:: inc-preappend
.. literalinclude:: literal.inc
:prepend: START CODE
:append: END CODE
.. literalinclude:: literal.inc
:start-after: utf-8
.. literalinclude:: literal.inc
:end-before: class Foo
.. literalinclude:: literal.inc
:diff: literal_orig.inc
.. cssclass:: inc-tab3
.. literalinclude:: tabs.inc
:tab-width: 3
:language: text
.. cssclass:: inc-tab8
.. literalinclude:: tabs.inc
:tab-width: 8
:language: python
.. cssclass:: inc-pyobj-lines-match
.. literalinclude:: literal.inc
:pyobject: Foo
:lineno-match:
.. cssclass:: inc-lines-match
.. literalinclude:: literal.inc
:lines: 6-7,8
:lineno-match:
.. cssclass:: inc-startend-match
.. literalinclude:: literal.inc
:start-after: coding: utf-8
:end-before: class Foo
:lineno-match:
Test if dedenting before parsing works.
.. highlight:: python
.. cssclass:: inc-pyobj-dedent
.. literalinclude:: literal.inc
:pyobject: Bar.baz
Docutils include with "literal"
===============================
While not recommended, it should work (and leave quotes alone).
.. include:: quotes.inc
:literal:
|
