How do I document classes imported from other modules – hence without the declaration module’s name?

by

Here is a way to accomplish what the OP asks for:

  1. Add an __all__ list in pkg/__init__.py:

    from base import Base    # Or use 'from base import *'

__all__ = ["Base"]

  2. Use .. automodule:: pkg in the .rst file.

Sphinx will now output documentation where the class name is shown as pkg.Base instead of pkg.base.Base.

More Related Contents:

  1. How to document Python packages using Sphinx
  2. What is __init__.py for?
  3. How to fix “Attempted relative import in non-package” even with __init__.py
  4. How to install pip with Python 3?
  5. beyond top level package error in relative import
  6. What is the purpose of the -m switch?
  7. How do I create a namespace package in Python?
  8. What’s the difference between a Python module and a Python package?
  9. Relative imports – ModuleNotFoundError: No module named x
  10. Python 3: ImportError “No Module named Setuptools”
  11. What is a Python egg?
  12. Can’t import my own modules in Python
  13. Standard way to embed version into Python package?
  14. Access data in package subdirectory [duplicate]
  15. pip install . creates only the dist-info not the package
  16. Python3 correct way to import relative or absolute?
  17. Can sphinx link to documents that are not located in directories below the root document?
  18. Package (Python PIL/Pillow) installed but I can’t import it
  19. Adding code to __init__.py
  20. Automatically document all modules recursively with Sphinx autodoc
  21. Flask(‘application’) versus Flask(__name__)
  22. How do I output a config value in a Sphinx .rst file?
  23. sphinx.ext.autodoc: Keeping names of constants in signature
  24. Difference between entry_points/console_scripts and scripts in setup.py?
  25. How to preserve line breaks when generating python docs using sphinx
  26. How to properly use relative or absolute imports in Python modules?
  27. What’s the difference between a module and package in Python?
  28. How would I cross-reference a function generated by autodoc in Sphinx?
  29. Namespace vs regular package
  30. pip fails to install packages from requirements.txt

Leave a Comment