Skip to content
Snippets Groups Projects
Commit 968b910c authored by vuillaut's avatar vuillaut
Browse files

use apidoc for docstring documentation

parent fef408fb
No related branches found
No related tags found
1 merge request!22Improve package doc
Pipeline #135743 passed
=====================
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
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:
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:
eossr package
=============
Subpackages
-----------
.. toctree::
:maxdepth: 4
eossr.api
eossr.metadata
eossr.scripts
Module contents
---------------
.. automodule:: eossr
:members:
:undoc-members:
:show-inheritance:
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:
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment