Skip to content

Conversation

misharash
Copy link
Contributor

I noticed that API docs on ReadTheDocs were broken: https://pyrecon.readthedocs.io/en/latest/api/api.html. A workaround is to use the stable version: https://pyrecon.readthedocs.io/en/stable/api/api.html, although it may be outdated.
I fixed some errors on the mpi branch, but autodoc still was not happy with circular imports. I created this new branch to eliminate them. It wasn't hard except the Cython submodule _multigrid. I was able to make it work with the doc Makefile, but I am not sure how to adapt this to ReadTheDocs.

@misharash
Copy link
Contributor Author

misharash commented May 20, 2025

I fixed the API docs on ReadTheDocs on the mpi branch without touching the main code (eliminating the circular imports in the form from . import submodule was apparently not necessary). So this PR could be dismissed

@misharash misharash changed the title Fix autodoc for API Eliminate circular imports May 20, 2025
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 this pull request may close these issues.

1 participant