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

Invalid packages import for geos-mesh, impacting documentation #32

Merged
merged 5 commits into from
Aug 5, 2024

Conversation

alexbenedicto
Copy link
Contributor

@alexbenedicto alexbenedicto commented Jul 16, 2024

Linked to #29
Geos-mesh feature files could not import packages from "src" correctly,
showing import errors in the documentation.

…nce leading to error when creating documentation
@untereiner
Copy link

seems not to be enough

@alexbenedicto
Copy link
Contributor Author

I tried the sphinx-build with all .rst files and weirdly, certain of them raise an error when reaching this line :

with mock(self.config.autodoc_mock_imports):

Do you know @untereiner if I can contact someone to help me with the sphinx-build ?

@alexbenedicto alexbenedicto linked an issue Jul 16, 2024 that may be closed by this pull request
@alexbenedicto
Copy link
Contributor Author

The sphinx-build works on my side, generating the complete documentation.
I keep investigating it

@untereiner
Copy link

\ is for windows filesytems. I suggest to keep /

@alexbenedicto
Copy link
Contributor Author

alexbenedicto commented Jul 23, 2024

@untereiner It appeared to be a sphinx / sphinx-argparse update required for the modules to be now recognized.
Regarding backslashes, I used to receive Warnings when using "/".
Do you want me to switch it back to "/" ?

@alexbenedicto
Copy link
Contributor Author

@untereiner I think it's ok now to merge

@untereiner untereiner merged commit 6759376 into main Aug 5, 2024
31 checks passed
@untereiner untereiner deleted the origin/bugfix/domentation_error2 branch August 5, 2024 12:38
alexbenedicto added a commit that referenced this pull request Oct 14, 2024
* First correction now allowing for the copy of fields from the original mesh to the 2 split meshes.
But the indexes of fields are not correct yet for fracture mesh.

* Module import paths update

* Fields are now copied correctly for fracture_mesh.

* Test case added to check the __copy_fields feature.

* Invalid packages import for geos-mesh, impacting documentation (#32)

Updating sphinx and sphinx-argparse solved the issue.

* Correction for yapf valid format.

* Had to make a workaround to avoid a weird yapf formatting suggestion.

* Mistake correction

* First correction now allowing for the copy of fields from the original mesh to the 2 split meshes.
But the indexes of fields are not correct yet for fracture mesh.

* Module import paths update

* Fields are now copied correctly for fracture_mesh.

* Test case added to check the __copy_fields feature.

* Correction for yapf valid format.

* Had to make a workaround to avoid a weird yapf formatting suggestion.

* Mistake correction

* First part of review corrections

* Second part correction of reviews

* Last part of correction review

* Updated method when linking old cells to new cells ids to copy correctly the fields
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Module import error in geos-mesh
2 participants