search

OpenEnergyPlatform / open-MaStR

A collaborative software to download the energy database Marktstammdatenregister (MaStR)
https://open-mastr.readthedocs.io/en/latest/
GNU Affero General Public License v3.0
87 stars 19 forks source link

Decide between apidoc and autodoc #167

Closed gplssm closed 2 years ago

gplssm commented 3 years ago

Currently, code reference is created from .rst files generator with sphinx-apidoc. It seems like sphinx autodoc is creating code reference at the same time as following logs indicate:

(py36_open_mastr) guido@RLI-NB-49:~/git/open-MaStR$ sphinx-build -E -a docs docs/_build/
Sphinx v3.4.3 in Verwendung
building [mo]: all of 0 po files
building [html]: all source files
updating environment: [new config] 11 added, 0 changed, 0 removed
reading sources... [100%] reference/open_mastr.utils                                                                                                                                                               
/home/guido/git/open-MaStR/open_mastr/soap_api/download.py:docstring of open_mastr.soap_api.download.MaStRAPI:1: WARNING: duplicate object description of open_mastr.soap_api.download.MaStRAPI, other instance in download, use :noindex: for one of them
/home/guido/git/open-MaStR/open_mastr/soap_api/download.py:docstring of open_mastr.soap_api.download.MaStRDownload:1: WARNING: duplicate object description of open_mastr.soap_api.download.MaStRDownload, other instance in download, use :noindex: for one of them
/home/guido/git/open-MaStR/open_mastr/soap_api/download.py:docstring of open_mastr.soap_api.download.MaStRDownload.additional_data:1: WARNING: duplicate object description of open_mastr.soap_api.download.MaStRDownload.additional_data, other instance in download, use :noindex: for one of them
/home/guido/git/open-MaStR/open_mastr/soap_api/download.py:docstring of open_mastr.soap_api.download.MaStRDownload.basic_unit_data:1: WARNING: duplicate object description of open_mastr.soap_api.download.MaStRDownload.basic_unit_data, other instance in download, use :noindex: for one of them
/home/guido/git/open-MaStR/open_mastr/soap_api/download.py:docstring of open_mastr.soap_api.download.MaStRDownload.download_power_plants:1: WARNING: duplicate object description of open_mastr.soap_api.download.MaStRDownload.download_power_plants, other instance in download, use :noindex: for one of them
/home/guido/git/open-MaStR/open_mastr/soap_api/download.py:docstring of open_mastr.soap_api.download.MaStRDownload.eeg_unit_data:1: WARNING: duplicate object description of open_mastr.soap_api.download.MaStRDownload.eeg_unit_data, other instance in download, use :noindex: for one of them
/home/guido/git/open-MaStR/open_mastr/soap_api/download.py:docstring of open_mastr.soap_api.download.MaStRDownload.extended_unit_data:1: WARNING: duplicate object description of open_mastr.soap_api.download.MaStRDownload.extended_unit_data, other instance in download, use :noindex: for one of them
/home/guido/git/open-MaStR/open_mastr/soap_api/download.py:docstring of open_mastr.soap_api.download.MaStRDownload.kwk_unit_data:1: WARNING: duplicate object description of open_mastr.soap_api.download.MaStRDownload.kwk_unit_data, other instance in download, use :noindex: for one of them
/home/guido/git/open-MaStR/open_mastr/soap_api/download.py:docstring of open_mastr.soap_api.download.MaStRDownload.permit_unit_data:1: WARNING: duplicate object description of open_mastr.soap_api.download.MaStRDownload.permit_unit_data, other instance in download, use :noindex: for one of them
/home/guido/git/open-MaStR/open_mastr/soap_api/mirror.py:docstring of open_mastr.soap_api.mirror.MaStRMirror:1: WARNING: duplicate object description of open_mastr.soap_api.mirror.MaStRMirror, other instance in download, use :noindex: for one of them
/home/guido/git/open-MaStR/open_mastr/soap_api/mirror.py:docstring of open_mastr.soap_api.mirror.MaStRMirror.backfill_basic:1: WARNING: duplicate object description of open_mastr.soap_api.mirror.MaStRMirror.backfill_basic, other instance in download, use :noindex: for one of them
/home/guido/git/open-MaStR/open_mastr/soap_api/mirror.py:docstring of open_mastr.soap_api.mirror.MaStRMirror.create_additional_data_requests:1: WARNING: duplicate object description of open_mastr.soap_api.mirror.MaStRMirror.create_additional_data_requests, other instance in download, use :noindex: for one of them
/home/guido/git/open-MaStR/open_mastr/soap_api/mirror.py:docstring of open_mastr.soap_api.mirror.MaStRMirror.dump:1: WARNING: duplicate object description of open_mastr.soap_api.mirror.MaStRMirror.dump, other instance in download, use :noindex: for one of them
/home/guido/git/open-MaStR/open_mastr/soap_api/mirror.py:docstring of open_mastr.soap_api.mirror.MaStRMirror.initdb:1: WARNING: duplicate object description of open_mastr.soap_api.mirror.MaStRMirror.initdb, other instance in download, use :noindex: for one of them
/home/guido/git/open-MaStR/open_mastr/soap_api/mirror.py:docstring of open_mastr.soap_api.mirror.MaStRMirror.restore:1: WARNING: duplicate object description of open_mastr.soap_api.mirror.MaStRMirror.restore, other instance in download, use :noindex: for one of them
/home/guido/git/open-MaStR/open_mastr/soap_api/mirror.py:docstring of open_mastr.soap_api.mirror.MaStRMirror.retrieve_additional_data:1: WARNING: duplicate object description of open_mastr.soap_api.mirror.MaStRMirror.retrieve_additional_data, other instance in download, use :noindex: for one of them
/home/guido/git/open-MaStR/open_mastr/soap_api/mirror.py:docstring of open_mastr.soap_api.mirror.MaStRMirror.to_csv:1: WARNING: duplicate object description of open_mastr.soap_api.mirror.MaStRMirror.to_csv, other instance in download, use :noindex: for one of them
/home/guido/git/open-MaStR/docs/reference/open_mastr.soap_api.rst:64: WARNING: duplicate label module contents, other instance in /home/guido/git/open-MaStR/docs/reference/open_mastr.rst
/home/guido/git/open-MaStR/docs/reference/open_mastr.utils.rst:5: WARNING: duplicate label submodules, other instance in /home/guido/git/open-MaStR/docs/reference/open_mastr.soap_api.rst
/home/guido/git/open-MaStR/docs/reference/open_mastr.utils.rst:16: WARNING: duplicate label module contents, other instance in /home/guido/git/open-MaStR/docs/reference/open_mastr.soap_api.rst

Do these steps

FlorianK13 commented 2 years ago

When building the doc pages with sphinx it creates many error warnings. Maybe this issue can explain that?