How to use sphinx automodule and exposed functions in __init__

by

It works if you add an __all__ list to the __init__.py files. For example:

"""The __init__ docstr"""

__all__ = ['func1', 'func2']

from m1 import *
from m2 import *

More Related Contents:

  1. Sphinx’s autodoc’s automodule having apparently no effect
  2. How do I document classes without the module name?
  3. Sphinx autodoc is not automatic enough
  4. Override function declaration in autodoc for sphinx
  5. Sphinx cannot find my python files. Says ‘no module named …’
  6. Can sphinx link to documents that are not located in directories below the root document?
  7. How do I document classes imported from other modules – hence without the declaration module’s name?
  8. Automatically document all modules recursively with Sphinx autodoc
  9. How to add custom css file to Sphinx?
  10. sphinx-build fail – autodoc can’t import/find module
  11. How do I output a config value in a Sphinx .rst file?
  12. sphinx.ext.autodoc: Keeping names of constants in signature
  13. Keeping the API updated in Sphinx
  14. How to preserve line breaks when generating python docs using sphinx
  15. How to force Sphinx to use Python 3.x interpreter
  16. How to document Python packages using Sphinx
  17. Customize sphinxdoc theme
  18. How to express multiple types for a single parameter or a return value in docstrings that are processed by Sphinx?
  19. How would I cross-reference a function generated by autodoc in Sphinx?
  20. How to sum all range output in python 3
  21. How to map dict into another dict Python
  22. join list of lists in python [duplicate]
  23. Pandas cannot open an Excel (.xlsx) file
  24. Pandas fill missing values in dataframe from another dataframe
  25. How can I generate a list of consecutive numbers?
  26. Slicing a numpy array along a dynamically specified axis
  27. Caused by SSLError(“Can’t connect to HTTPS URL because the SSL module is not available.”
  28. Why can’t Python increment variable in closure?
  29. Why/When in Python does `x==y` call `y.__eq__(x)`?
  30. Can I perform dynamic cumsum of rows in pandas?

Leave a Comment