diff --git a/docs/docstring.rst b/docs/docstring.rst index 73fe2f0f1b40e7e18fbd522ee40816bcea925c31..884dca22191c4104f1ba485916218ede0a3ace38 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 0000000000000000000000000000000000000000..1785295b68615ced017fbe1a93c0f2c2c15a0a2b --- /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 0000000000000000000000000000000000000000..ffedd29fac4b360e45c82822ca66e7ba90becadf --- /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 0000000000000000000000000000000000000000..1e6155527dc379602226d715c1d8f8db09f51673 --- /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 0000000000000000000000000000000000000000..299dd3f88a99d532b4dbce6c9b47126c654e2bce --- /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: