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

Rename femmt.py due to same pip-package name #11

Closed
gituser789 opened this issue Dec 14, 2021 · 0 comments
Closed

Rename femmt.py due to same pip-package name #11

gituser789 opened this issue Dec 14, 2021 · 0 comments

Comments

@gituser789
Copy link
Contributor

gituser789 commented Dec 14, 2021

Describe the bug
Package problems when having a package name 'femmt' which imports .femmt.py
Seems to be that the package is builds successfully, but problems occour when generating the documentation.
When renaming 'femmt.py' e.g. to 'femmt_classes.py', this works fine.

To Reproduce
Steps to reproduce the behavior:

  1. cd sphinx/
  2. make clean
  3. make html
  4. See error
WARNING: autodoc: failed to import class 'MagneticComponent.VirtualWindingWindow' from module 'femmt'; the following exception was raised:
attempted relative import with no known parent package

When opening sphinx/build/html/index.html, the MagneticComponent-Class description is empty.

Expected behavior
Build documentation without mentioned warning, and display a documentation for MagneticComponent-class.

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

No branches or pull requests

1 participant