From 968b910c8516bda246af01516f0f8efecd1d09d0 Mon Sep 17 00:00:00 2001
From: vuillaut <thomas.vuillaume@gmail.com>
Date: Wed, 15 Sep 2021 09:31:39 +0200
Subject: [PATCH] use apidoc for docstring documentation

---
 docs/docstring.rst                        | 21 +++--------
 docs/docstring_sources/eossr.api.rst      | 21 +++++++++++
 docs/docstring_sources/eossr.metadata.rst | 21 +++++++++++
 docs/docstring_sources/eossr.rst          | 20 ++++++++++
 docs/docstring_sources/eossr.scripts.rst  | 45 +++++++++++++++++++++++
 5 files changed, 112 insertions(+), 16 deletions(-)
 create mode 100644 docs/docstring_sources/eossr.api.rst
 create mode 100644 docs/docstring_sources/eossr.metadata.rst
 create mode 100644 docs/docstring_sources/eossr.rst
 create mode 100644 docs/docstring_sources/eossr.scripts.rst

diff --git a/docs/docstring.rst b/docs/docstring.rst
index 73fe2f0f..884dca22 100644
--- a/docs/docstring.rst
+++ b/docs/docstring.rst
@@ -1,22 +1,11 @@
 =====================
-Package Documentation
+EOSSR Documentation
 =====================
 
 Autogenerated documentation from docstrings.
 
-API module
--------------
+.. toctree::
+   :maxdepth: 4
+   :glob:
 
-.. automodule:: eossr.api.zenodo
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-
-Metadata module
-----------------------
-
-.. automodule:: eossr.metadata.codemeta2zenodo
-   :members:
-   :undoc-members:
-   :show-inheritance:
+   ../docstring_sources/eossr.rst
\ No newline at end of file
diff --git a/docs/docstring_sources/eossr.api.rst b/docs/docstring_sources/eossr.api.rst
new file mode 100644
index 00000000..1785295b
--- /dev/null
+++ b/docs/docstring_sources/eossr.api.rst
@@ -0,0 +1,21 @@
+eossr.api package
+=================
+
+Submodules
+----------
+
+eossr.api.zenodo module
+-----------------------
+
+.. automodule:: eossr.api.zenodo
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: eossr.api
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/docstring_sources/eossr.metadata.rst b/docs/docstring_sources/eossr.metadata.rst
new file mode 100644
index 00000000..ffedd29f
--- /dev/null
+++ b/docs/docstring_sources/eossr.metadata.rst
@@ -0,0 +1,21 @@
+eossr.metadata package
+======================
+
+Submodules
+----------
+
+eossr.metadata.codemeta2zenodo module
+-------------------------------------
+
+.. automodule:: eossr.metadata.codemeta2zenodo
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: eossr.metadata
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/docstring_sources/eossr.rst b/docs/docstring_sources/eossr.rst
new file mode 100644
index 00000000..1e615552
--- /dev/null
+++ b/docs/docstring_sources/eossr.rst
@@ -0,0 +1,20 @@
+eossr package
+=============
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   eossr.api
+   eossr.metadata
+   eossr.scripts
+
+Module contents
+---------------
+
+.. automodule:: eossr
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/docstring_sources/eossr.scripts.rst b/docs/docstring_sources/eossr.scripts.rst
new file mode 100644
index 00000000..299dd3f8
--- /dev/null
+++ b/docs/docstring_sources/eossr.scripts.rst
@@ -0,0 +1,45 @@
+eossr.scripts package
+=====================
+
+Submodules
+----------
+
+eossr.scripts.check\_connection\_zenodo module
+----------------------------------------------
+
+.. automodule:: eossr.scripts.check_connection_zenodo
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+eossr.scripts.eossr\_codemeta2zenodo module
+-------------------------------------------
+
+.. automodule:: eossr.scripts.eossr_codemeta2zenodo
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+eossr.scripts.eossr\_upload\_new\_deposit module
+------------------------------------------------
+
+.. automodule:: eossr.scripts.eossr_upload_new_deposit
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+eossr.scripts.eossr\_upload\_new\_version\_deposit module
+---------------------------------------------------------
+
+.. automodule:: eossr.scripts.eossr_upload_new_version_deposit
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: eossr.scripts
+   :members:
+   :undoc-members:
+   :show-inheritance:
-- 
GitLab