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

API reference has disappeared from docs #154

Closed
tom-andersson opened this issue Feb 10, 2025 · 1 comment · Fixed by #155
Closed

API reference has disappeared from docs #154

tom-andersson opened this issue Feb 10, 2025 · 1 comment · Fixed by #155
Assignees

Comments

@tom-andersson
Copy link
Collaborator

The API reference pages are still present, but the content has disappeared, for example: https://alan-turing-institute.github.io/deepsensor/reference/data/loader.html

The API reference should be generated automatically by the 'sphinx.ext.autodoc' extension from source code docstrings, but the latest GitHub Actions docs workflow run has these errors:

/home/runner/work/deepsensor/deepsensor/docs/getting-started/installation.md:43: WARNING: Unknown directive type: 'bash' [myst.directive_unknown]
WARNING: autodoc: failed to import module 'active_learning.acquisition_fns' from module 'deepsensor'; the following exception was raised:
No module named 'deepsensor.data'
WARNING: autodoc: failed to import module 'active_learning.algorithms' from module 'deepsensor'; the following exception was raised:
No module named 'deepsensor.data'
WARNING: autodoc: failed to import class 'data.loader.TaskLoader' from module 'deepsensor'; the following exception was raised:
No module named 'deepsensor.data'
WARNING: autodoc: failed to import module 'data.processor' from module 'deepsensor'; the following exception was raised:
No module named 'deepsensor.data'
WARNING: autodoc: failed to import module 'data.sources' from module 'deepsensor'; the following exception was raised:
No module named 'deepsensor.data'
WARNING: autodoc: failed to import module 'data.task' from module 'deepsensor'; the following exception was raised:
No module named 'deepsensor.data'
WARNING: autodoc: failed to import module 'data.utils' from module 'deepsensor'; the following exception was raised:
No module named 'deepsensor.data'
WARNING: autodoc: failed to import module 'model.convnp' from module 'deepsensor'; the following exception was raised:
No module named 'deepsensor.data'
WARNING: autodoc: failed to import module 'model.defaults' from module 'deepsensor'; the following exception was raised:
No module named 'deepsensor.data'
WARNING: autodoc: failed to import module 'model.model' from module 'deepsensor'; the following exception was raised:
No module named 'deepsensor.data'
WARNING: autodoc: failed to import module 'model.nps' from module 'deepsensor'; the following exception was raised:
No module named 'deepsensor.data'
WARNING: autodoc: failed to import module 'model.pred' from module 'deepsensor'; the following exception was raised:
No module named 'deepsensor.data'
WARNING: autodoc: failed to import module 'plot' from module 'deepsensor'; the following exception was raised:
No module named 'deepsensor.data'
WARNING: autodoc: failed to import module 'train.train' from module 'deepsensor'; the following exception was raised:
No module named 'deepsensor.data'

I locally ran jupyter-book build docs --all and the pages had correctly been generated. I have not synced in a while, so it's something to do with the repo and/or a recent change at HEAD.

@davidwilby perhaps you could take a look? Feel free to assign me if not.

@davidwilby
Copy link
Collaborator

This issue is now fixed. We're also now using an up to date version of jupyter-book - let me know if you see any other issues in the docs.

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.

2 participants