Giters

django-import-export / django-import-export

Django application and library for importing and exporting data with admin integration.

Home Page:https://django-import-export.readthedocs.org/en/latest/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Wrong indent in `skip_row` code block breaks intersphinx build

ulliholtgrave opened this issue · comments

commented

Describe the bug
We recently added your library to our django project, but our documentation build keeps failing with the following error:
:docstring of import_export.resources.Resource.skip_row:22: ERROR: Unexpected indentation.
This is related to our intersphinx setup which isn't able to parse the docstring of this django-import-export.

To Reproduce
Have a project with an intersphinx setup and use the resources.ModelResource in your code.

Versions:

  • Django Import Export: 3.3.6
  • Python 3.11
  • Django 3.2

Expected behavior
The docstring of skip_row should be successfully parsed and linked.

Additional context
This seems to be a problem of the missing line before the code block.

commented

Thanks for reporting and submitting PR. May I recommend using v4 beta for new developments, as this has a lot of new features and fixes, and will be the main supported version from 2024.