search

IRL2 / nanover-docs

Source code for the read the docs NanoVer documentation.
https://irl2.github.io/nanover-docs/
0 stars 0 forks source link

Warnings about failing to import modules when building #134

Open rhoslynroebuck opened 1 week ago

rhoslynroebuck commented 1 week ago

We are getting the below errors when building the docs. @Ragzouken you said some docstrings might need fixing?

WARNING: Failed to import nanover.ase.omm_calculator.
Possible hints:
* ModuleNotFoundError: No module named 'nanover.ase.omm_calculator'
* AttributeError: module 'nanover.ase' has no attribute 'omm_calculator'
WARNING: Failed to import nanover.omni.ase.
Possible hints:
* AttributeError: module 'nanover.omni' has no attribute 'ase'
* ModuleNotFoundError: No module named 'nanover.omni.ase'
WARNING: Failed to import nanover.omni.rich.
Possible hints:
* AttributeError: module 'nanover.omni' has no attribute 'rich'
* ModuleNotFoundError: No module named 'textual'
WARNING: Failed to import nanover.mdanalysis.recordings.
Possible hints:
* AttributeError: module 'nanover.mdanalysis' has no attribute 'recordings'
* ModuleNotFoundError: No module named 'nanover.mdanalysis.recordings'

WARNING: autodoc: failed to import module 'omm_calculator' from module 'nanover.ase'; the following exception was raised:
No module named 'nanover.ase.omm_calculator'
WARNING: autodoc: failed to import module 'recordings' from module 'nanover.mdanalysis'; the following exception was raised:
No module named 'nanover.mdanalysis.recordings'
....\nanover-docs\Lib\site-packages\nanover\nglview\nglclient.py:docstring of nanover.nglview.nglclient.NGLClient:15: WARNING: Inline emphasis start-string without end-string.
....\nanover-docs\Lib\site-packages\nanover\nglview\nglclient.py:docstring of nanover.nglview.nglclient.NGLClient:18: WARNING: Inline strong start-string without end-string.
....\nanover-docs\Lib\site-packages\nanover\nglview\nglclient.py:docstring of nanover.nglview.nglclient.frame_data_to_nglwidget:7: WARNING: Inline emphasis start-string without end-string.
WARNING: autodoc: failed to import module 'ase' from module 'nanover.omni'; the following exception was raised:
No module named 'nanover.omni.ase'
WARNING: autodoc: failed to import module 'rich' from module 'nanover.omni'; the following exception was raised:
No module named 'textual'
Ragzouken commented 1 week ago

One of the problems is that this module moved to nanover.recording.reading and nanover.recording.writing: https://github.com/IRL2/nanover-docs/blob/771d9b133a012bcbb48763ccacd8938c4064c25d/source/concepts/recording.rst?plain=1#L201

Ragzouken commented 1 week ago

* ModuleNotFoundError: No module named 'nanover.omni.ase' this I don't understand, because that one does exist.

This one is because "textual" isn't part of the dependencies, it's optional. Maybe for docs purposes it should be installed anyway.

WARNING: Failed to import nanover.omni.rich.
Possible hints:
* AttributeError: module 'nanover.omni' has no attribute 'rich'
* ModuleNotFoundError: No module named 'textual'
rhoslynroebuck commented 1 week ago

Thanks for the info, I've added a PR about the Textual package. Maybe we can discuss the rest in person or in the next dev meeting.