From 011c16ae768243b6d6b2ec99fb0240e8e7243c83 Mon Sep 17 00:00:00 2001 From: Chris Sewell Date: Fri, 24 Feb 2023 12:52:57 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=91=8C=20Remove=20description=20title=20o?= =?UTF-8?q?f=20modules?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/apidocs/aiida/aiida.cmdline.rst | 4 ---- docs/apidocs/aiida/aiida.common.rst | 4 ---- docs/apidocs/aiida/aiida.engine.rst | 4 ---- docs/apidocs/aiida/aiida.manage.rst | 4 ---- docs/apidocs/aiida/aiida.orm.rst | 4 ---- docs/apidocs/aiida/aiida.parsers.rst | 4 ---- docs/apidocs/aiida/aiida.plugins.rst | 4 ---- docs/apidocs/aiida/aiida.repository.rst | 4 ---- docs/apidocs/aiida/aiida.rst | 4 ---- docs/apidocs/aiida/aiida.schedulers.rst | 4 ---- docs/apidocs/aiida/aiida.tools.rst | 4 ---- docs/apidocs/aiida/aiida.transports.rst | 4 ---- docs/apidocs/autodoc2/autodoc2.analysis.rst | 4 ---- docs/apidocs/autodoc2/autodoc2.astroid_utils.rst | 4 ---- docs/apidocs/autodoc2/autodoc2.cli.rst | 4 ---- docs/apidocs/autodoc2/autodoc2.config.rst | 4 ---- docs/apidocs/autodoc2/autodoc2.db.md | 2 -- docs/apidocs/autodoc2/autodoc2.extension.rst | 4 ---- docs/apidocs/autodoc2/autodoc2.render.base.rst | 4 ---- docs/apidocs/autodoc2/autodoc2.render.myst_.rst | 4 ---- docs/apidocs/autodoc2/autodoc2.render.rst | 4 ---- docs/apidocs/autodoc2/autodoc2.render.rst_.rst | 4 ---- docs/apidocs/autodoc2/autodoc2.rst | 4 ---- docs/apidocs/autodoc2/autodoc2.utils.rst | 4 ---- src/autodoc2/render/myst_.py | 2 -- src/autodoc2/render/rst_.py | 6 +----- tests/test_render/test_basic_myst_.md | 2 -- tests/test_render/test_basic_rst_.rst | 4 ---- 28 files changed, 1 insertion(+), 107 deletions(-) diff --git a/docs/apidocs/aiida/aiida.cmdline.rst b/docs/apidocs/aiida/aiida.cmdline.rst index 1cba80f..476740b 100644 --- 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 index a5833df..279265a 100644 --- 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 index 7921650..75196c9 100644 --- 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 index 31a9668..e9483c1 100644 --- 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 index 0f6357f..df21b1f 100644 --- 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 index ed5d52e..f577b01 100644 --- 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 index b689123..11570a8 100644 --- 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 index 9edb08a..449d3ee 100644 --- 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 index 28ee356..9debb26 100644 --- 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 index b44fe8b..49bb60c 100644 --- 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 index 409d10b..03d8a7e 100644 --- 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 index 313774d..1e62405 100644 --- 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 index 4b0ec4a..4b830c5 100644 --- 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 index 374a4c5..c651006 100644 --- 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 index c36ad57..0d00eeb 100644 --- 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 index 7e85ca4..8cd9155 100644 --- 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 index 359ab02..7cc7584 100644 --- 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 index e0bf4f0..de015fc 100644 --- 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 index d027bbe..47f0e67 100644 --- 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 index a58042f..4b7ac2b 100644 --- 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 index ffe9abf..d58bae9 100644 --- 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 index b3f823b..bfd81ea 100644 --- 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 index 6cf811a..78e2825 100644 --- 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 index 35474e8..146c146 100644 --- 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 index a35d055..fa09633 100644 --- 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 index 5613da1..1558100 100644 --- 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 index 9ff02aa..e61a8a9 100644 --- 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 index 772693e..94fd9c5 100644 --- 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: