readthedocs / readthedocs/sphinx-autoapi

Option to disable docstring inheritance

Open
#489 3 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
494
Forks
147
Avg merge
9m
Merged PRs (30d)
1

Description

I have read the sphinx-autoapi documentation thoroughly but it isn't clear exactly how Sphinx's autodoc is leveraged by sphinx-autoapi. In any case, the following does not work:

...
extensions = ['autoapi.extension', 'sphinx.ext.autodoc']
autodoc_inherit_docstrings = False
...

So there appears to be no way to instruct sphinx-autoapi not to inherit docstrings.

I would prefer being able to fine-tune autodoc directly (as above), but if that just isn't compatible with the sphinx-autoapi architecture, I would certainly settle for an equivalent of the autodoc_inherit_docstrings setting.

Edited to remove incorrect assumption

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the sphinx-autoapi documentation and the extension entry points named in the configuration example, then determine how docstrings are inherited. The work is complete when users can disable inherited docstrings through a documented setting equivalent to autodoc_inherit_docstrings, or can control the behavior through Sphinx autodoc configuration.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.