Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

sphinx-autoapi v3.2.1 generates duplicate object warnings #822

Closed
bkeryan opened this issue Jul 31, 2024 · 1 comment · Fixed by #810
Closed

sphinx-autoapi v3.2.1 generates duplicate object warnings #822

bkeryan opened this issue Jul 31, 2024 · 1 comment · Fixed by #810
Labels
bug Something isn't working

Comments

@bkeryan
Copy link
Collaborator

bkeryan commented Jul 31, 2024

          The new version of sphinx-autoapi is producing more warnings about duplicate objects.
/home/runner/work/measurement-plugin-python/measurement-plugin-python/packages/service/_docs_source/autoapi/ni_measurement_plugin_sdk_service/measurement/service/index.rst:138: WARNING: duplicate object description of ni_measurement_plugin_sdk_service.measurement.service.MeasurementService.measurement_info, other instance in autoapi/ni_measurement_plugin_sdk_service/measurement/service/index, use :no-index: for one of them
/home/runner/work/measurement-plugin-python/measurement-plugin-python/packages/service/_docs_source/autoapi/ni_measurement_plugin_sdk_service/measurement/service/index.rst:144: WARNING: duplicate object description of ni_measurement_plugin_sdk_service.measurement.service.MeasurementService.service_info, other instance in autoapi/ni_measurement_plugin_sdk_service/measurement/service/index, use :no-index: for one of them
/home/runner/work/measurement-plugin-python/measurement-plugin-python/packages/service/_docs_source/autoapi/ni_measurement_plugin_sdk_service/measurement/service/index.rst:147: WARNING: duplicate object description of ni_measurement_plugin_sdk_service.measurement.service.MeasurementService.context, other instance in autoapi/ni_measurement_plugin_sdk_service/measurement/service/index, use :no-index: for one of them

Originally posted by @bkeryan in #810 (comment)

AB#2817983

@bkeryan bkeryan added the bug Something isn't working label Jul 31, 2024
@bkeryan bkeryan linked a pull request Jul 31, 2024 that will close this issue
1 task
@bkeryan
Copy link
Collaborator Author

bkeryan commented Jul 31, 2024

Here's what I think is happening:

Removing the Napoleon "Attributes:" keyword and adding docstrings after the attribute assignments seems to be a reasonable way to fix this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant