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

GitHub Action misses autodoc for the driver module #1

Closed
slobentanzer opened this issue Oct 7, 2021 · 2 comments
Closed

GitHub Action misses autodoc for the driver module #1

slobentanzer opened this issue Oct 7, 2021 · 2 comments

Comments

@slobentanzer
Copy link
Collaborator

slobentanzer commented Oct 7, 2021

For some reason, the page built by the action does not correctly display autodoc for the driver module (it does create a section for the module, but no autodoc). Other modules work fine, and the VSCode preview on my machine also works fine. Bug in the Action script?

@deeenes
Copy link
Contributor

deeenes commented Oct 7, 2021

Maybe because of this:

WARNING: autodoc: failed to import module 'driver' from module 'biocypher'; the following exception was raised:

No module named 'neo4j'
/github/workspace/biocypher/check.py:docstring of biocypher.check:16: WARNING: Unknown directive type "todo".

The last line is only a warning but might be good to address.

@slobentanzer
Copy link
Collaborator Author

Yes, that was it. Solved by adding autodoc_mock_imports = ["neo4j"] to the config. It worked locally because neo4j was installed and the preview function uses the active environment, whereas on the Action node, neo4j is missing.

nilskre pushed a commit that referenced this issue Apr 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

No branches or pull requests

2 participants