summaryrefslogtreecommitdiffstats
path: root/tests/roots/test-footnotes
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-04 11:31:33 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-04 11:31:33 +0000
commite863fd965dd6253243c3342bd6f0adc4fc8aec4d (patch)
treea4c1b6491a82593950043c3f8b2530e80664d768 /tests/roots/test-footnotes
parentInitial commit. (diff)
downloadsphinx-upstream.tar.xz
sphinx-upstream.zip
Adding upstream version 5.3.0.upstream/5.3.0upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r--tests/roots/test-footnotes/bar.rst6
-rw-r--r--tests/roots/test-footnotes/baz.rst6
-rw-r--r--tests/roots/test-footnotes/conf.py1
-rw-r--r--tests/roots/test-footnotes/index.rst188
-rw-r--r--tests/roots/test-footnotes/rimg.pngbin0 -> 120 bytes
5 files changed, 201 insertions, 0 deletions
diff --git a/tests/roots/test-footnotes/bar.rst b/tests/roots/test-footnotes/bar.rst
new file mode 100644
index 0000000..660c663
--- /dev/null
+++ b/tests/roots/test-footnotes/bar.rst
@@ -0,0 +1,6 @@
+bar
+===
+
+Same footnote number [1]_ in bar.rst
+
+.. [1] footnote in bar
diff --git a/tests/roots/test-footnotes/baz.rst b/tests/roots/test-footnotes/baz.rst
new file mode 100644
index 0000000..af496c5
--- /dev/null
+++ b/tests/roots/test-footnotes/baz.rst
@@ -0,0 +1,6 @@
+baz
+===
+
+Auto footnote number [#]_ in baz.rst
+
+.. [#] footnote in baz
diff --git a/tests/roots/test-footnotes/conf.py b/tests/roots/test-footnotes/conf.py
new file mode 100644
index 0000000..a45d22e
--- /dev/null
+++ b/tests/roots/test-footnotes/conf.py
@@ -0,0 +1 @@
+exclude_patterns = ['_build']
diff --git a/tests/roots/test-footnotes/index.rst b/tests/roots/test-footnotes/index.rst
new file mode 100644
index 0000000..9ac1a9c
--- /dev/null
+++ b/tests/roots/test-footnotes/index.rst
@@ -0,0 +1,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 <http://sphinx-doc.org/>`_
+* Third footnote: [#]_
+* Fourth footnote: [#named]_
+* `URL including tilde <http://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 <http://sphinx-doc.org/>`_
+ Description Description Description ...
+
+Footnote in term [#]_
+ Description Description Description ...
+
+ `Term in deflist <http://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)
+ :noindex:
+
+Footnotes referred twice
+========================
+
+* Explicitly numbered footnote: [100]_ [100]_
+* Named footnote: [#twice]_ [#twice]_
+
+.. [100] Numbered footnote
+.. [#twice] Named footnote
diff --git a/tests/roots/test-footnotes/rimg.png b/tests/roots/test-footnotes/rimg.png
new file mode 100644
index 0000000..fda6cd2
--- /dev/null
+++ b/tests/roots/test-footnotes/rimg.png
Binary files differ