summaryrefslogtreecommitdiffstats
path: root/tests/roots/test-footnotes/index.rst
blob: e4490ed41f721840c06cf0c7121adc2b8b6abde4 (plain)
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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
===============
test-footenotes
===============

.. toctree::

   bar
   baz

.. contents::
   :local:

The section with a reference to [AuthorYear]_
=============================================

.. figure:: rimg.png

   This is the figure caption with a reference to [AuthorYear]_.

.. list-table:: The table title with a reference to [AuthorYear]_
   :header-rows: 1

   * - Header1
     - Header2
   * - Content
     - Content

.. rubric:: The rubric title with a reference to [AuthorYear]_

.. [#] First

* First footnote: [#]_
* Second footnote: [1]_
* `Sphinx <https://sphinx-doc.org/>`_
* Third footnote: [#]_
* Fourth footnote: [#named]_
* `URL including tilde <https://sphinx-doc.org/~test/>`_
* GitHub Page: `https://github.com/sphinx-doc/sphinx <https://github.com/sphinx-doc/sphinx>`_
* Mailing list: `sphinx-dev@googlegroups.com <mailto:sphinx-dev@googlegroups.com>`_

.. [AuthorYear] Author, Title, Year
.. [1] Second
.. [#] Third [#]_
.. [#] Footnote inside footnote
.. [#named] Fourth

The section with a reference to [#]_
=====================================

.. [#] Footnote in section

`URL in term <https://sphinx-doc.org/>`_
    Description Description Description ...

Footnote in term [#]_
    Description Description Description ...

    `Term in deflist <https://sphinx-doc.org/>`_
        Description2

.. [#] Footnote in term

.. figure:: rimg.png

   This is the figure caption with a footnote to [#]_.

.. [#] Footnote in caption

.. list-table:: footnote [#]_ in caption of normal table
    :widths: 1 1
    :header-rows: 1

    * - name
      - desc
    * - a
      - b
    * - a
      - b

.. [#] Foot note in table

.. list-table:: footnote [#]_ in caption [#]_ of longtable
    :widths: 1 1
    :header-rows: 1

    * - name
      - desc
    * - This is a reference to the code-block in the footnote:
        :ref:`codeblockinfootnote`
      - This is one more footnote with some code in it [#]_.
    * - This is a reference to the other code block:
        :ref:`codeblockinanotherfootnote`
      - b
    * - a
      - b
    * - a
      - b
    * - a
      - b
    * - a
      - b
    * - a
      - b
    * - a
      - b
    * - a
      - b
    * - a
      - b
    * - a
      - b
    * - a
      - b
    * - a
      - b
    * - a
      - b
    * - a
      - b
    * - a
      - b
    * - a
      - b
    * - a
      - b
    * - a
      - b
    * - a
      - b
    * - a
      - b
    * - a
      - b
    * - a
      - b
    * - a
      - b
    * - a
      - b
    * - a
      - b
    * - a
      - b
    * - a
      - b
    * - a
      - b
    * - a
      - b
    * - a
      - b
    * - a
      - b

.. [#] Foot note in longtable

.. [#] Second footnote in caption of longtable

       .. code-block:: python
          :caption: I am in a footnote
          :name: codeblockinfootnote

          def foo(x,y):
              return x+y

.. [#] Third footnote in longtable

       .. code-block:: python
          :caption: I am also in a footnote
          :name: codeblockinanotherfootnote

          def bar(x,y):
              return x+y

The section with an object description
======================================

.. py:function:: dummy(N)
   :no-index:

Footnotes referred twice
========================

* Explicitly numbered footnote: [100]_ [100]_
* Named footnote: [#twice]_ [#twice]_

.. [100] Numbered footnote
.. [#twice] Named footnote