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

Test autodoc2 #327

Open
Tracked by #324
j-emberton opened this issue Oct 11, 2024 · 4 comments
Open
Tracked by #324

Test autodoc2 #327

j-emberton opened this issue Oct 11, 2024 · 4 comments
Assignees

Comments

@j-emberton
Copy link
Collaborator

Switch out autodoc for autodoc2 and evaluate any improvement to the docs build.

Review which currently used dependencies become deprecated through use of autodoc2

@MarionBWeinzierl
Copy link
Collaborator

Is this basically the differences we are looking at? https://sphinx-autodoc2.readthedocs.io/en/latest/autodoc_diff.html

@j-emberton
Copy link
Collaborator Author

yes I think so

@MarionBWeinzierl MarionBWeinzierl moved this from Todo to In Progress in ICCS development board Nov 26, 2024
@MarionBWeinzierl MarionBWeinzierl self-assigned this Nov 26, 2024
@MarionBWeinzierl
Copy link
Collaborator

Hm, I am getting this error when setting
autodoc2_packages = [ "../../pyrealm" ]
Image

@j-emberton
Copy link
Collaborator Author

Hm, I am getting this error when setting autodoc2_packages = [ "../../pyrealm" ] Image

That doesn't look good. I'm not sure I have much confidence in autodoc2. It seems a little abandoned. We could try posting an issue with this error to see if the lead dev responds, but I'm not hopeful.

@MarionBWeinzierl MarionBWeinzierl moved this from In Progress to Icebox in ICCS development board Nov 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Icebox
Development

No branches or pull requests

2 participants