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.

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

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

Closed
sjg20 opened this issue Apr 10, 2024 · 3 comments · Fixed by #1367
Closed

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

sjg20 opened this issue Apr 10, 2024 · 3 comments · Fixed by #1367

Comments

@sjg20
Copy link
Contributor

sjg20 commented Apr 10, 2024

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
Copy link
Member

Emantor commented Apr 11, 2024

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
Copy link
Member

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
Copy link
Contributor Author

sjg20 commented Apr 20, 2024

OK, will do. I also hit this problem:

readthedocs/readthedocs.org#9038

Python seems to be a disaster at the moment

sjg20 added a commit to sjg20/labgrid that referenced this issue Apr 20, 2024
The 'make html' command fails witht he [doc] build. Update the
documentation to show how to resolve this.

Fixes: labgrid-project#1352

Signed-off-by: Simon Glass <sjg@chromium.org>
sjg20 added a commit to sjg20/labgrid that referenced this issue Apr 20, 2024
The 'make html' command fails with the [doc] build. Update the
documentation to show how to resolve this.

Fixes: labgrid-project#1352

Signed-off-by: Simon Glass <sjg@chromium.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants