labgrid-project / labgrid

Embedded systems control library for development, testing and installation
https://labgrid.readthedocs.io/
Other
327 stars 164 forks source link

docs: WARNING: autodoc: failed to import module 'eaton' from module ... #1352

Closed sjg20 closed 4 months ago

sjg20 commented 5 months ago

I am seeing warnings when building the docs:

cd doc
make html
...
WARNING: autodoc: failed to import module 'eaton' from module 'labgrid.driver.power'; the following exception was raised:
No module named 'pysnmp'
WARNING: autodoc: failed to import module 'poe_mib' from module 'labgrid.driver.power'; the following exception was raised:
No module named 'pysnmp'
WARNING: autodoc: failed to import module 'raritan' from module 'labgrid.driver.power'; the following exception was raised:
No module named 'pysnmp'
WARNING: autodoc: failed to import module 'siglent' from module 'labgrid.driver.power'; the following exception was raised:
No module named 'vxi11'
WARNING: autodoc: failed to import module 'tplink' from module 'labgrid.driver.power'; the following exception was raised:
No module named 'kasa'
WARNING: autodoc: failed to import module 'snmp' from module 'labgrid.util'; the following exception was raised:
No module named 'pysnmp'
Emantor commented 4 months ago

Looks like we have a whole bunch of modules which were never added to the pyproject.toml file but are required for automatic doc generation. We'll need to check whether they are required or if the warnings can be safely ignored.

Bastian-Krause commented 4 months ago

Looks like we have a whole bunch of modules which were never added to the pyproject.toml file but are required for automatic doc generation. We'll need to check whether they are required or if the warnings can be safely ignored.

Huh? All these modules are referenced in the pyproject.toml in the "dev" extra.

@sjg20 If you want to have autodoc functionality, follow the steps in the docs, but use pip install -e ".[dev]" instead of pip install -e ".[doc]". A PR adding this to this docs section would be appreciated :)

sjg20 commented 4 months ago

OK, will do. I also hit this problem:

https://github.com/readthedocs/readthedocs.org/issues/9038

Python seems to be a disaster at the moment