sphinx-build fail – autodoc can’t import/find module

by

Autodoc can’t find your modules, because they are not in sys.path.

You have to include the path to your modules in in the sys.path in your conf.py.
Look at the top of your conf.py (just after the import of sys), there is a sys.path.insert() statement, which you can adapt.

By the way: you can use the Makefile created by Sphinx to create your documentation.
Just call

make

to see the options.

If something went wrong before try:

make clean

before running make html.

More Related Contents:

  1. Sphinx’s autodoc’s automodule having apparently no effect
  2. Sphinx autodoc is not automatic enough
  3. Override function declaration in autodoc for sphinx
  4. Sphinx cannot find my python files. Says ‘no module named …’
  5. Automatically document all modules recursively with Sphinx autodoc
  6. sphinx.ext.autodoc: Keeping names of constants in signature
  7. How would I cross-reference a function generated by autodoc in Sphinx?
  8. How do I document classes without the module name?
  9. Can sphinx link to documents that are not located in directories below the root document?
  10. How do I document classes imported from other modules – hence without the declaration module’s name?
  11. How to add custom css file to Sphinx?
  12. How do I output a config value in a Sphinx .rst file?
  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. How to use sphinx automodule and exposed functions in __init__
  18. Customize sphinxdoc theme
  19. How to express multiple types for a single parameter or a return value in docstrings that are processed by Sphinx?
  20. Static methods in Python?
  21. urllib and “SSL: CERTIFICATE_VERIFY_FAILED” Error
  22. How to truncate float values?
  23. Python script to do something at the same time every day [duplicate]
  24. Pandas: How to easily share a sample dataframe using df.to_dict()?
  25. Purpose of calling function without brackets python
  26. What does the random.sample() method in Python do?
  27. Python Flask Render Text from Variable like render_template
  28. Import module works in terminal but not in IDLE
  29. How to convert numbers to words without using num2word library?
  30. PyQT QTableWidget extremely slow

Leave a Comment