weso / hercules-sync

Tools to synchronise data between the ontology files and Wikibase instance for the Hercules project at University of Murcia.
GNU General Public License v3.0
4 stars 1 forks source link

Fix autodoc warnings #13

Closed alejgh closed 4 years ago

alejgh commented 4 years ago

When using Sphinx to generate the documentation of the module the following warnings are raised by Travis:

332. /home/travis/build/weso/hercules-sync/hercules_sync/git.py:docstring of hercules_sync.git.GitFile.added_lines:7: WARNING: Definition list ends without a blank line; unexpected unindent.
333. /home/travis/build/weso/hercules-sync/hercules_sync/git.py:docstring of hercules_sync.git.GitFile.removed_lines:7: WARNING: Definition list ends without a blank line; unexpected unindent.
334. WARNING: autodoc: failed to import module 'listener' from module 'hercules_sync'; the following exception was raised:
...
361. /home/travis/build/weso/hercules-sync/hercules_sync/webhook.py:docstring of hercules_sync.webhook.WebHook.hook:4: WARNING: Unexpected section title.

The last one will be eventually fixed when the module is finished, but the others need to be considered.

alejgh commented 4 years ago

Closed in #59