sphinx-extensions2 · chrisjsewell · Feb 24, 2023 · Feb 24, 2023
diff --git a/docs/apidocs/aiida/aiida.cmdline.rst b/docs/apidocs/aiida/aiida.cmdline.rst
@@ -3,10 +3,6 @@
 
 .. py:module:: aiida.cmdline
 
-
-Description
------------
-
 .. autodoc2-docstring:: aiida.cmdline
    :renderer: rst
    :allowtitles:

diff --git a/docs/apidocs/aiida/aiida.common.rst b/docs/apidocs/aiida/aiida.common.rst
@@ -3,10 +3,6 @@
 
 .. py:module:: aiida.common
 
-
-Description
------------
-
 .. autodoc2-docstring:: aiida.common
    :renderer: rst
    :allowtitles:

diff --git a/docs/apidocs/aiida/aiida.engine.rst b/docs/apidocs/aiida/aiida.engine.rst
@@ -3,10 +3,6 @@
 
 .. py:module:: aiida.engine
 
-
-Description
------------
-
 .. autodoc2-docstring:: aiida.engine
    :renderer: rst
    :allowtitles:

diff --git a/docs/apidocs/aiida/aiida.manage.rst b/docs/apidocs/aiida/aiida.manage.rst
@@ -3,10 +3,6 @@
 
 .. py:module:: aiida.manage
 
-
-Description
------------
-
 .. autodoc2-docstring:: aiida.manage
    :renderer: rst
    :allowtitles:

diff --git a/docs/apidocs/aiida/aiida.orm.rst b/docs/apidocs/aiida/aiida.orm.rst
@@ -3,10 +3,6 @@
 
 .. py:module:: aiida.orm
 
-
-Description
------------
-
 .. autodoc2-docstring:: aiida.orm
    :renderer: rst
    :allowtitles:

diff --git a/docs/apidocs/aiida/aiida.parsers.rst b/docs/apidocs/aiida/aiida.parsers.rst
@@ -3,10 +3,6 @@
 
 .. py:module:: aiida.parsers
 
-
-Description
------------
-
 .. autodoc2-docstring:: aiida.parsers
    :renderer: rst
    :allowtitles:

diff --git a/docs/apidocs/aiida/aiida.plugins.rst b/docs/apidocs/aiida/aiida.plugins.rst
@@ -3,10 +3,6 @@
 
 .. py:module:: aiida.plugins
 
-
-Description
------------
-
 .. autodoc2-docstring:: aiida.plugins
    :renderer: rst
    :allowtitles:

diff --git a/docs/apidocs/aiida/aiida.repository.rst b/docs/apidocs/aiida/aiida.repository.rst
@@ -3,10 +3,6 @@
 
 .. py:module:: aiida.repository
 
-
-Description
------------
-
 .. autodoc2-docstring:: aiida.repository
    :renderer: rst
    :allowtitles:

diff --git a/docs/apidocs/aiida/aiida.rst b/docs/apidocs/aiida/aiida.rst
@@ -3,10 +3,6 @@
 
 .. py:module:: aiida
 
-
-Description
------------
-
 .. autodoc2-docstring:: aiida
    :renderer: rst
    :allowtitles:

diff --git a/docs/apidocs/aiida/aiida.schedulers.rst b/docs/apidocs/aiida/aiida.schedulers.rst
@@ -3,10 +3,6 @@
 
 .. py:module:: aiida.schedulers
 
-
-Description
------------
-
 .. autodoc2-docstring:: aiida.schedulers
    :renderer: rst
    :allowtitles:

diff --git a/docs/apidocs/aiida/aiida.tools.rst b/docs/apidocs/aiida/aiida.tools.rst
@@ -3,10 +3,6 @@
 
 .. py:module:: aiida.tools
 
-
-Description
------------
-
 .. autodoc2-docstring:: aiida.tools
    :renderer: rst
    :allowtitles:

diff --git a/docs/apidocs/aiida/aiida.transports.rst b/docs/apidocs/aiida/aiida.transports.rst
@@ -3,10 +3,6 @@
 
 .. py:module:: aiida.transports
 
-
-Description
------------
-
 .. autodoc2-docstring:: aiida.transports
    :renderer: rst
    :allowtitles:

diff --git a/docs/apidocs/autodoc2/autodoc2.analysis.rst b/docs/apidocs/autodoc2/autodoc2.analysis.rst
@@ -3,10 +3,6 @@
 
 .. py:module:: autodoc2.analysis
 
-
-Description
------------
-
 .. autodoc2-docstring:: autodoc2.analysis
    :renderer: rst
    :allowtitles:

diff --git a/docs/apidocs/autodoc2/autodoc2.astroid_utils.rst b/docs/apidocs/autodoc2/autodoc2.astroid_utils.rst
@@ -3,10 +3,6 @@
 
 .. py:module:: autodoc2.astroid_utils
 
-
-Description
------------
-
 .. autodoc2-docstring:: autodoc2.astroid_utils
    :renderer: rst
    :allowtitles:

diff --git a/docs/apidocs/autodoc2/autodoc2.cli.rst b/docs/apidocs/autodoc2/autodoc2.cli.rst
@@ -3,10 +3,6 @@
 
 .. py:module:: autodoc2.cli
 
-
-Description
------------
-
 .. autodoc2-docstring:: autodoc2.cli
    :renderer: rst
    :allowtitles:

diff --git a/docs/apidocs/autodoc2/autodoc2.config.rst b/docs/apidocs/autodoc2/autodoc2.config.rst
@@ -3,10 +3,6 @@
 
 .. py:module:: autodoc2.config
 
-
-Description
------------
-
 .. autodoc2-docstring:: autodoc2.config
    :renderer: rst
    :allowtitles:

diff --git a/docs/apidocs/autodoc2/autodoc2.db.md b/docs/apidocs/autodoc2/autodoc2.db.md
@@ -3,8 +3,6 @@
 ```{py:module} autodoc2.db
 ```
 
-## Description
-
 ```{autodoc2-docstring} autodoc2.db
 :renderer: myst
    :allowtitles:

diff --git a/docs/apidocs/autodoc2/autodoc2.extension.rst b/docs/apidocs/autodoc2/autodoc2.extension.rst
@@ -3,10 +3,6 @@
 
 .. py:module:: autodoc2.extension
 
-
-Description
------------
-
 .. autodoc2-docstring:: autodoc2.extension
    :renderer: rst
    :allowtitles:

diff --git a/docs/apidocs/autodoc2/autodoc2.render.base.rst b/docs/apidocs/autodoc2/autodoc2.render.base.rst
@@ -3,10 +3,6 @@
 
 .. py:module:: autodoc2.render.base
 
-
-Description
------------
-
 .. autodoc2-docstring:: autodoc2.render.base
    :renderer: rst
    :allowtitles:

diff --git a/docs/apidocs/autodoc2/autodoc2.render.myst_.rst b/docs/apidocs/autodoc2/autodoc2.render.myst_.rst
@@ -3,10 +3,6 @@
 
 .. py:module:: autodoc2.render.myst_
 
-
-Description
------------
-
 .. autodoc2-docstring:: autodoc2.render.myst_
    :renderer: rst
    :allowtitles:

diff --git a/docs/apidocs/autodoc2/autodoc2.render.rst b/docs/apidocs/autodoc2/autodoc2.render.rst
@@ -3,10 +3,6 @@
 
 .. py:module:: autodoc2.render
 
-
-Description
------------
-
 .. autodoc2-docstring:: autodoc2.render
    :renderer: rst
    :allowtitles:

diff --git a/docs/apidocs/autodoc2/autodoc2.render.rst_.rst b/docs/apidocs/autodoc2/autodoc2.render.rst_.rst
@@ -3,10 +3,6 @@
 
 .. py:module:: autodoc2.render.rst_
 
-
-Description
------------
-
 .. autodoc2-docstring:: autodoc2.render.rst_
    :renderer: rst
    :allowtitles:

diff --git a/docs/apidocs/autodoc2/autodoc2.rst b/docs/apidocs/autodoc2/autodoc2.rst
@@ -3,10 +3,6 @@
 
 .. py:module:: autodoc2
 
-
-Description
------------
-
 .. autodoc2-docstring:: autodoc2
    :renderer: rst
    :allowtitles:

diff --git a/docs/apidocs/autodoc2/autodoc2.utils.rst b/docs/apidocs/autodoc2/autodoc2.utils.rst
@@ -3,10 +3,6 @@
 
 .. py:module:: autodoc2.utils
 
-
-Description
------------
-
 .. autodoc2-docstring:: autodoc2.utils
    :renderer: rst
    :allowtitles:

diff --git a/src/autodoc2/render/myst_.py b/src/autodoc2/render/myst_.py
@@ -82,8 +82,6 @@ def render_package(self, item: ItemData) -> t.Iterable[str]:
         yield from ["```", ""]
 
         yield from [
-            "## Description",
-            "",
             f"```{{autodoc2-docstring}} {item['full_name']}",
             f":renderer: {self.NAME}",
             "   :allowtitles:",

diff --git a/src/autodoc2/render/rst_.py b/src/autodoc2/render/rst_.py
@@ -71,12 +71,8 @@ def render_package(self, item: ItemData) -> t.Iterable[str]:
             yield "   :noindex:"
         if self.is_module_deprecated(item):
             yield "   :deprecated:"
-        yield from ["", ""]
-
+        yield ""
         yield from [
-            "Description",
-            "-----------",
-            "",
             f".. autodoc2-docstring:: {item['full_name']}",
             f"   :renderer: {self.NAME}",
             "   :allowtitles:",

diff --git a/tests/test_render/test_basic_myst_.md b/tests/test_render/test_basic_myst_.md
@@ -3,8 +3,6 @@
 ```{py:module} package
 ```
 
-## Description
-
 ```{autodoc2-docstring} package
 :renderer: myst
    :allowtitles:

diff --git a/tests/test_render/test_basic_rst_.rst b/tests/test_render/test_basic_rst_.rst
@@ -3,10 +3,6 @@
 
 .. py:module:: package
 
-
-Description
------------
-
 .. autodoc2-docstring:: package
    :renderer: rst
    :allowtitles: