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.

Sign up for GitHub

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

Jump to bottom

ignore things that are re-exported via __init__.py? #204

Closed
dzheng256 opened this issue May 11, 2020 · 2 comments
Closed

ignore things that are re-exported via __init__.py? #204

dzheng256 opened this issue May 11, 2020 · 2 comments
Labels
Enhancement Language: Python

Comments

@dzheng256
Copy link

If I have, for example
b/module.py and a/__init__.py which does from b.module import BClass, then in the docs autoapi generates there is also a.BClass. How can I prevent this re-export from getting picked up? This behavior seems a bit odd to me, though I suppose it may be intentional. However I don't want to have this in my docs, and I haven't found a way to fix it via a config option.
@AWhetter
Copy link
Collaborator

The members are included because AutoAPI aims to document anything that is accessible through the actual module when loaded in Python, which includes anything that has been imported.
However I've added an imported-members value to autoapi_options that you can remove to disable this behaviour.

@dzheng256
Copy link
Author

dzheng256 commented May 17, 2020 •
edited

thanks @AWhetter! when will a new release of sphinx-autoapi containing this feature be published?

@dzheng256 dzheng256 mentioned this issue May 28, 2020
Closed
netbsd-srcmastr pushed a commit to NetBSD/pkgsrc that referenced this issue Aug 24, 2020
py-sphinx-autoapi: update to 1.4.0.
bdbe7bb 
v1.4.0 (2020-06-07)
-------------------

Features
^^^^^^^^
* `#197 <https://github.com/readthedocs/sphinx-autoapi/issues/197>`: Added
  ``autoapi.__version__`` and ``autoapi.__version_info__`` attributes
  for accessing version information.
* `#201 <https://github.com/readthedocs/sphinx-autoapi/issues/201>`: (Python)
  Added the ``autoapi_member_order`` option to allow the order that members
  are documentated to be configurable.
* `#203 <https://github.com/readthedocs/sphinx-autoapi/issues/203>`: (Python)
  A class without a docstring inherits one from its parent.
  A methods without a docstring inherits one from the method that it overrides.
* `#204 <https://github.com/readthedocs/sphinx-autoapi/issues/204>`: (Python)
  Added the ``imported-members`` AutoAPI option to be able to enable or disable
  documenting objects imported from the same top-level package or module
  without needing to override templates.

Bug Fixes
^^^^^^^^^
* `#198 <https://github.com/readthedocs/sphinx-autoapi/issues/198>`:
  Documentation describes the required layout for template override directories.
* `#195 <https://github.com/readthedocs/sphinx-autoapi/issues/195>`: (Python)
  Fixed incorrect formatting when ``show-inheritance-diagram``
  and ``private-members`` are turned on.
* `#193 <https://github.com/readthedocs/sphinx-autoapi/issues/193>` and
* `#208 <https://github.com/readthedocs/sphinx-autoapi/issues/208>`: (Python)
  Inheritance diagrams can follow imports to find classes to document.
* `#213 <https://github.com/readthedocs/sphinx-autoapi/issues/213>`: (Python)
  Fixed module summary never showing.

Trivial/Internal Changes
^^^^^^^^^^^^^^^^^^^^^^^^
* black shows diffs by default
* `#207 <https://github.com/readthedocs/sphinx-autoapi/issues/207>`:
  Fixed a typo in the code of the golang tutorial.
@cdancette cdancette mentioned this issue Jan 23, 2021
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Enhancement Language: Python
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@AWhetter @dzheng256