Fix rst syntax

zopefoundation · Feb 11, 2025 · 3395dc5 · 3395dc5
1 parent b7b8d3b
commit 3395dc5
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 21 deletions.
diff --git a/README.rst b/README.rst
@@ -64,28 +64,24 @@ Imagine this situation:
 * The template override in the project no longer works and the other person starts asking questions or complaining.
 
 To solve this problem, you can register that a template path is deprecated.
-First add a dictionary to the ``base`` package, let's say in a file ``utils.py``:
-
-```
-deprecated_templates = {
-    "base.original.pt": "base.new.pt",
-}
-```
-
-In your ``configure.zcml`` you add:
-
-```
-<configure
-    xmlns="http://namespaces.zope.org/zope"
-    xmlns:zcml="http://namespaces.zope.org/zcml"
-    >
-...
-  <configure zcml:condition="have jbot-deprecations">
-    <include package="z3c.jbot" file="meta.zcml" />
-    <jbot:jbotDeprecated dictionary=".utils.deprecated_templates">
+First add a dictionary to the ``base`` package, let's say in a file ``utils.py``::
+
+  deprecated_templates = {
+      "base.original.pt": "base.new.pt",
+  }
+
+In your ``configure.zcml`` you add::
+
+  <configure
+      xmlns="http://namespaces.zope.org/zope"
+      xmlns:zcml="http://namespaces.zope.org/zcml"
+      >
+  ...
+    <configure zcml:condition="have jbot-deprecations">
+      <include package="z3c.jbot" file="meta.zcml" />
+      <jbot:jbotDeprecated dictionary=".utils.deprecated_templates">
+    </configure>
   </configure>
-</configure>
-```
 
 TODO: check if I have this correct.  I think we need to define xmlns:jbot.
 

diff --git a/setup.py b/setup.py
@@ -8,6 +8,7 @@
     description="Drop-in template overrides.",
     long_description=(open('README.rst').read() + "\n" +
                       open('CHANGES.rst').read()),
+    long_description_content_type='text/x-rst',
     classifiers=[
         'Development Status :: 5 - Production/Stable',
         'Framework :: Zope',