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

Missing API reference documentation due to import failures during sphinx build #92

Open
tristanls opened this issue Dec 5, 2024 · 0 comments
Labels
bug Something isn't working documentation Improvements or additions to documentation infrastructure Changes to infrastructure triaged This issue or pull request was triaged

Comments

@tristanls
Copy link
Contributor

tristanls commented Dec 5, 2024

Describe the bug

Example of skipped documentation due to import errors:

...
Failed to import tbp.monty.frameworks.loggers.wandb_handlers.
Possible hints:
* AttributeError: module 'tbp.monty.frameworks.loggers' has no attribute 'wandb_handlers'
* ValueError: not enough values to unpack (expected 2, got 0)
Failed to import tbp.monty.frameworks.environments.embodied_data.
Possible hints:
* AttributeError: module 'tbp.monty.frameworks.environments' has no attribute 'embodied_data'
* AttributeError: module 'numpy' has no attribute 'quaternion'
Failed to import tbp.monty.frameworks.config_utils.config_args.
Possible hints:
* AttributeError: module 'tbp.monty.frameworks.config_utils' has no attribute 'config_args'
* ValueError: not enough values to unpack (expected 2, got 0)
Failed to import tbp.monty.frameworks.config_utils.make_dataset_configs.
Possible hints:
* AttributeError: module 'tbp.monty.frameworks.config_utils' has no attribute 'make_dataset_configs'
* AttributeError: module 'numpy' has no attribute 'quaternion'
Failed to import tbp.monty.frameworks.experiments.
Possible hints:
* AttributeError: module 'tbp.monty.frameworks' has no attribute 'experiments'
* AttributeError: module 'numpy' has no attribute 'quaternion'
Failed to import tbp.monty.frameworks.experiments.data_collection_experiments.
Possible hints:
* AttributeError: module 'tbp.monty.frameworks' has no attribute 'experiments'
* AttributeError: module 'numpy' has no attribute 'quaternion'
Failed to import tbp.monty.frameworks.experiments.monty_experiment.
Possible hints:
* AttributeError: module 'tbp.monty.frameworks' has no attribute 'experiments'
* AttributeError: module 'numpy' has no attribute 'quaternion'
Failed to import tbp.monty.frameworks.experiments.object_recognition_experiments.
Possible hints:
* AttributeError: module 'tbp.monty.frameworks' has no attribute 'experiments'
* AttributeError: module 'numpy' has no attribute 'quaternion'
Failed to import tbp.monty.frameworks.experiments.pretraining_experiments.
Possible hints:
* AttributeError: module 'tbp.monty.frameworks' has no attribute 'experiments'
* AttributeError: module 'numpy' has no attribute 'quaternion'
Failed to import tbp.monty.frameworks.experiments.profile.
Possible hints:
* AttributeError: module 'tbp.monty.frameworks' has no attribute 'experiments'
* AttributeError: module 'numpy' has no attribute 'quaternion'
Failed to import tbp.monty.frameworks.run_parallel.
Possible hints:
* AttributeError: module 'tbp.monty.frameworks' has no attribute 'run_parallel'
* AttributeError: module 'numpy' has no attribute 'quaternion'
Failed to import tbp.monty.frameworks.models.motor_policies.
Possible hints:
* AttributeError: module 'tbp.monty.frameworks.models' has no attribute 'motor_policies'
* AttributeError: module 'numpy' has no attribute 'quaternion'
Failed to import tbp.monty.frameworks.utils.follow_up_configs.
Possible hints:
* AttributeError: module 'tbp.monty.frameworks.utils' has no attribute 'follow_up_configs'
* AttributeError: module 'numpy' has no attribute 'quaternion'
Failed to import tbp.monty.frameworks.utils.plot_utils.
Possible hints:
* AttributeError: module 'tbp.monty.frameworks.utils' has no attribute 'plot_utils'
* ValueError: not enough values to unpack (expected 2, got 0)
Failed to import tbp.monty.frameworks.utils.transform_utils.
Possible hints:
* AttributeError: module 'numpy' has no attribute 'quaternion'
* AttributeError: module 'tbp.monty.frameworks.utils' has no attribute 'transform_utils'
...

See https://github.com/thousandbrainsproject/tbp.monty/actions/runs/12122919030/job/33797510667 or similar.

Note that what fails to import does not show in the API Reference docs:

Screenshot 2024-12-05 at 10 19 55
@tristanls tristanls added bug Something isn't working documentation Improvements or additions to documentation triaged This issue or pull request was triaged infrastructure Changes to infrastructure labels Dec 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation infrastructure Changes to infrastructure triaged This issue or pull request was triaged
Projects
None yet
Development

No branches or pull requests

1 participant