Skip to content

Instantly share code, notes, and snippets.

@humitos
Created August 25, 2023 17:32
Show Gist options
  • Save humitos/11dac3efa0ed0bca4bb4d06f5facc1f2 to your computer and use it in GitHub Desktop.
Save humitos/11dac3efa0ed0bca4bb4d06f5facc1f2 to your computer and use it in GitHub Desktop.
Differences between docutils 0.18 and 0.20 on Read the Docs Sphinx Theme
▶ colordiff -u /home/humitos/rtfd/code/sphinx_rtd_theme/.tox/py310-sphinx72/tmp/html/demo/demo.html /home/humitos/rtfd/code/sphinx_rtd_theme/.tox/py310-sphinx72-qa/tmp/html/demo/demo.html
--- /home/humitos/rtfd/code/sphinx_rtd_theme/.tox/py310-sphinx72/tmp/html/demo/demo.html 2023-08-25 19:29:48.401670197 +0200
+++ /home/humitos/rtfd/code/sphinx_rtd_theme/.tox/py310-sphinx72-qa/tmp/html/demo/demo.html 2023-08-25 19:28:19.342350784 +0200
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
- <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
+ <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta content="reStructuredText, demonstration, demo, parser" name="keywords" />
<meta content="A demonstration of the reStructuredText markup language, containing examples of all basic constructs and many advanced constructs." lang="en" name="description" xml:lang="en" />
@@ -457,14 +457,14 @@
<section id="footnotes">
<h3><a class="toc-backref" href="#id55" role="doc-backlink"><span class="section-number">3.6.1. </span>Footnotes</a><a class="headerlink" href="#footnotes" title="Link to this heading"></a></h3>
<aside class="footnote-list brackets">
-<aside class="footnote brackets" id="id15" role="note">
+<aside class="footnote brackets" id="id15" role="doc-footnote">
<span class="label"><span class="fn-bracket">[</span>1<span class="fn-bracket">]</span></span>
<span class="backrefs">(<a role="doc-backlink" href="#id1">1</a>,<a role="doc-backlink" href="#id6">2</a>,<a role="doc-backlink" href="#id7">3</a>,<a role="doc-backlink" href="#id8">4</a>,<a role="doc-backlink" href="#id9">5</a>,<a role="doc-backlink" href="#id10">6</a>,<a role="doc-backlink" href="#id11">7</a>,<a role="doc-backlink" href="#id12">8</a>,<a role="doc-backlink" href="#id13">9</a>,<a role="doc-backlink" href="#id14">10</a>,<a role="doc-backlink" href="#id16">11</a>)</span>
<p>A footnote contains body elements, consistently indented by at
least 3 spaces.</p>
<p>This is the footnote’s second paragraph.</p>
</aside>
-<aside class="footnote brackets" id="label" role="note">
+<aside class="footnote brackets" id="label" role="doc-footnote">
<span class="label"><span class="fn-bracket">[</span>2<span class="fn-bracket">]</span></span>
<span class="backrefs">(<a role="doc-backlink" href="#id3">1</a>,<a role="doc-backlink" href="#id17">2</a>)</span>
<p>Footnotes may be numbered, either manually (as in <a class="footnote-reference brackets" href="#id15" id="id16" role="doc-noteref"><span class="fn-bracket">[</span>1<span class="fn-bracket">]</span></a>) or
@@ -473,21 +473,21 @@
footnote reference (<a class="footnote-reference brackets" href="#label" id="id17" role="doc-noteref"><span class="fn-bracket">[</span>2<span class="fn-bracket">]</span></a>) and as a hyperlink reference
(<a class="reference internal" href="#label">label</a>).</p>
</aside>
-<aside class="footnote brackets" id="id18" role="note">
+<aside class="footnote brackets" id="id18" role="doc-footnote">
<span class="label"><span class="fn-bracket">[</span><a role="doc-backlink" href="#id2">3</a><span class="fn-bracket">]</span></span>
<p>This footnote is numbered automatically and anonymously using a
label of “#” only.</p>
</aside>
-<aside class="footnote brackets" id="id19" role="note">
+<aside class="footnote brackets" id="id19" role="doc-footnote">
<span class="label"><span class="fn-bracket">[</span><a role="doc-backlink" href="#id4">*</a><span class="fn-bracket">]</span></span>
<p>Footnotes may also use symbols, specified with a “*” label.
Here’s a reference to the next footnote: <a class="footnote-reference brackets" href="#id21" id="id20" role="doc-noteref"><span class="fn-bracket">[</span>†<span class="fn-bracket">]</span></a>.</p>
</aside>
-<aside class="footnote brackets" id="id21" role="note">
+<aside class="footnote brackets" id="id21" role="doc-footnote">
<span class="label"><span class="fn-bracket">[</span><a role="doc-backlink" href="#id20">†</a><span class="fn-bracket">]</span></span>
<p>This footnote shows the next symbol in the sequence.</p>
</aside>
-<aside class="footnote brackets" id="id22" role="note">
+<aside class="footnote brackets" id="id22" role="doc-footnote">
<span class="label"><span class="fn-bracket">[</span>4<span class="fn-bracket">]</span></span>
<p>Here’s an unreferenced footnote, with a reference to a
nonexistent footnote: <a href="#id71"><span class="problematic" id="id23">[5]_</span></a>.</p>
@@ -503,12 +503,12 @@
</div>
</div>
<aside class="footnote-list brackets">
-<aside class="footnote brackets" id="id24" role="note">
+<aside class="footnote brackets" id="id24" role="doc-footnote">
<span class="label"><span class="fn-bracket">[</span><a role="doc-backlink" href="#id5">12</a><span class="fn-bracket">]</span></span>
<p>This citation has some <code class="docutils literal notranslate"><span class="pre">code</span> <span class="pre">blocks</span></code> in it, maybe some <strong>bold</strong> and
<em>italics</em> too. Heck, lets put a link to a meta citation <a class="footnote-reference brackets" href="#id26" id="id25" role="doc-noteref"><span class="fn-bracket">[</span>13<span class="fn-bracket">]</span></a> too.</p>
</aside>
-<aside class="footnote brackets" id="id26" role="note">
+<aside class="footnote brackets" id="id26" role="doc-footnote">
<span class="label"><span class="fn-bracket">[</span><a role="doc-backlink" href="#id25">13</a><span class="fn-bracket">]</span></span>
<p>This citation will have two backlinks.</p>
</aside>
@@ -687,7 +687,7 @@
<section id="target-footnotes">
<h3><a class="toc-backref" href="#id67" role="doc-backlink"><span class="section-number">3.7.6. </span>Target Footnotes</a><a class="headerlink" href="#target-footnotes" title="Link to this heading"></a></h3>
<aside class="footnote-list brackets">
-<aside class="footnote brackets" id="id37" role="note">
+<aside class="footnote brackets" id="id37" role="doc-footnote">
<span class="label"><span class="fn-bracket">[</span>5<span class="fn-bracket">]</span></span>
<span class="backrefs">(<a role="doc-backlink" href="#id38">1</a>,<a role="doc-backlink" href="#id39">2</a>,<a role="doc-backlink" href="#id40">3</a>)</span>
<p><a class="reference external" href="http://www.python.org/">http://www.python.org/</a></p>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment