Release 37.1 (pypa#259)

miketheman · Sep 3, 2022 · e662bf4 · e662bf4
1 parent c6a3c1c
commit e662bf4
Show file tree

Hide file tree

Showing 5 changed files with 49 additions and 2 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -1,6 +1,11 @@
 Changes
 =======
 
+37.1 (2022-09-03)
+-----------------
+
+* Allow HTML5 `nav` tag through cleaner (#259)
+
 37.0 (2022-08-21)
 -----------------
 

diff --git a/readme_renderer/__about__.py b/readme_renderer/__about__.py
@@ -29,7 +29,7 @@
 )
 __uri__ = "https://github.com/pypa/readme_renderer"
 
-__version__ = "37.0"
+__version__ = "37.1"
 
 __author__ = "The Python Packaging Authority"
 __email__ = "admin@mail.pypi.org"

diff --git a/readme_renderer/clean.py b/readme_renderer/clean.py
@@ -30,7 +30,7 @@
     "br", "caption", "cite", "col", "colgroup", "dd", "del", "details", "div",
     "dl", "dt", "h1", "h2", "h3", "h4", "h5", "h6", "hr", "img", "p", "pre",
     "span", "sub", "summary", "sup", "table", "tbody", "td", "th", "thead",
-    "tr", "tt", "kbd", "var", "input", "section", "aside",
+    "tr", "tt", "kbd", "var", "input", "section", "aside", "nav",
 ]
 
 ALLOWED_ATTRIBUTES = {
@@ -63,6 +63,7 @@
     "dl": ["class"],
     "dt": ["class"],
     "ul": ["class"],
+    "nav": ["class"],
 }
 
 

diff --git a/tests/fixtures/test_rst_contents.html b/tests/fixtures/test_rst_contents.html
@@ -0,0 +1,22 @@
+<nav class="contents" id="contents">
+<p class="topic-title">Contents</p>
+<ul class="simple">
+<li><p><a href="#features" id="toc-entry-1" rel="nofollow">Features</a></p></li>
+<li><p><a href="#installation" id="toc-entry-2" rel="nofollow">Installation</a></p></li>
+</ul>
+</nav>
+<section id="features">
+<h2><a href="#toc-entry-1" rel="nofollow">Features</a></h2>
+<ul class="simple">
+<li><p>Eats cheese</p></li>
+</ul>
+</section>
+<section id="installation">
+<h2><a href="#toc-entry-2" rel="nofollow">Installation</a></h2>
+<p class="section-subtitle" id="requirements">Requirements</p>
+<ul class="simple">
+<li><p>Teeth</p></li>
+<li><p>Good taste</p></li>
+</ul>
+<p>Let’s eat some cheese together!</p>
+</section>
diff --git a/tests/fixtures/test_rst_contents.rst b/tests/fixtures/test_rst_contents.rst
@@ -0,0 +1,19 @@
+.. Tests that using a Table of Contents directive renders correctly
+
+.. contents::
+
+Features
+========
+
+* Eats cheese
+
+Installation
+============
+
+Requirements
+------------
+
+* Teeth
+* Good taste
+
+Let's eat some cheese together!