feat: allow admonitions to be rendered (#242)

* test: add test fixtures for admonitions

Create failing examples to test desired behavior.

Signed-off-by: Mike Fiedler <miketheman@gmail.com>

* feat: allow `class` attributes for `div` and `p`

docutils' admonitions renders the blocks using `class` attributes,
which can then be styled via CSS.
Allow `class` attributes to pass through the cleaner.

Signed-off-by: Mike Fiedler <miketheman@gmail.com>

* fix: add `class` to existing test fixtures

With the allowance that `class` may now be passed for `div`,
update fixtures to conform to the new directive.

Signed-off-by: Mike Fiedler <miketheman@gmail.com>

Co-authored-by: Dustin Ingram <di@users.noreply.github.com>

readme_renderer/clean.py

@@ -47,15 +47,15 @@
     "span": ["class"],
     "th": ["align"],
     "td": ["align"],
-    "div": ["align"],
+    "div": ["align", "class"],
     "h1": ["align"],
     "h2": ["align"],
     "h3": ["align"],
     "h4": ["align"],
     "h5": ["align"],
     "h6": ["align"],
     "code": ["class"],
-    "p": ["align"],
+    "p": ["align", "class"],
     "ol": ["start"],
     "input": ["type", "checked", "disabled"],
 }

tests/fixtures/test_rst_003.html

@@ -1,8 +1,8 @@
-<div id="required-packages">
+<div class="section" id="required-packages">
 <h2>Required packages</h2>
 <p>To run the PyPI software, you need Python 2.5+ and PostgreSQL</p>
 </div>
-<div id="quick-development-setup">
+<div class="section" id="quick-development-setup">
 <h2>Quick development setup</h2>
 <p>Make sure you are sitting</p>
 </div>

tests/fixtures/test_rst_admonitions.html

@@ -0,0 +1,13 @@
+<div class="admonition danger">
+<p class="first admonition-title">!DANGER!</p>
+<p class="last">Will Robinson</p>
+</div>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">F Sharp is a note, right?</p>
+</div>
+<div class="admonition admonition-see-also">
+<p class="first admonition-title">See also</p>
+<p class="last">A customized admonition.
+Read more at <a href="https://docutils.sourceforge.io/docs/ref/rst/directives.html#admonitions" rel="nofollow">docutils</a></p>
+</div>

tests/fixtures/test_rst_admonitions.rst

@@ -0,0 +1,11 @@
+.. danger:: Will Robinson
+
+.. note::
+
+   F Sharp is a note, right?
+
+
+.. admonition:: See also
+
+   A customized admonition.
+   Read more at `docutils <https://docutils.sourceforge.io/docs/ref/rst/directives.html#admonitions>`_

tests/fixtures/test_rst_docinfo.html

@@ -14,6 +14,6 @@
 <td>© 2017, 2018 Lele Gaifax</td></tr>
 </tbody>
 </table>
-<div id="pg-query">
+<div class="section" id="pg-query">
 <h2>pg_query</h2>
 </div>

tests/fixtures/test_rst_linkify.html

@@ -7,7 +7,7 @@
 <p>It requires a spatial databases compatible with <a href="https://docs.djangoproject.com/en/dev/ref/contrib/gis/" rel="nofollow">GeoDjango</a>.  <a href="http://www.postgresql.org" rel="nofollow">PostgreSQL</a> 9.x
 and <a href="http://postgis.refractions.net" rel="nofollow">PostGIS</a> 2.x are recommended for development and production, since these
 support all the GeoDjango features.</p>
-<div id="status">
+<div class="section" id="status">
 <h2>Status</h2>
 <p>multigtfs is ready for your GTFS project.</p>
 <p>Point releases (0.4.1 to 0.4.2) should be safe, only adding features or fixing
@@ -25,11 +25,11 @@ <h2>Status</h2>
 archive feeds).  If you find a feed that doesn’t work, <a href="https://github.com/tulsawebdevs/django-multi-gtfs/issues" rel="nofollow">file a bug</a>!</p>
 <p>See the <a href="https://github.com/tulsawebdevs/django-multi-gtfs/issues?state=open" rel="nofollow">issues list</a> for more details on bugs and feature requests.</p>
 </div>
-<div id="example-project">
+<div class="section" id="example-project">
 <h2>Example project</h2>
 <p>Check out the <a href="examples/explore/README.md" rel="nofollow">example project</a>.</p>
 </div>
-<div id="development">
+<div class="section" id="development">
 <h2>Development</h2>
 <table>
 <colgroup><col>