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

DOC: sphinx Didn't find <class attribute> in <module> when building docs #220

Open
fkuehlein opened this issue Mar 14, 2024 · 2 comments · Fixed by #232
Open

DOC: sphinx Didn't find <class attribute> in <module> when building docs #220

fkuehlein opened this issue Mar 14, 2024 · 2 comments · Fixed by #232
Labels
maintenance something should be improved or is outdated

Comments

@fkuehlein
Copy link
Collaborator

class added in #156, but missing in docs/source/api/climate

@fkuehlein fkuehlein added the maintenance something should be improved or is outdated label Mar 14, 2024
@fkuehlein
Copy link
Collaborator Author

fkuehlein commented Jul 1, 2024

while at it, might also look into countless cases like

reading sources... [ 50%] api/core/network
Didn't find Network.N in pyunicorn.core.network

when building docs.

This happens for class attributes only, not for class methods. Yet, all attributes appear alright in the built documentation, so it doesn't cause an actual issue. Using .. autoclass:: instead of .. automodule:: e.g. in api/core/network.rst will fix the warning, but doesn't really apply here as we want to document modules.

fkuehlein added a commit that referenced this issue Jul 3, 2024
- and fix docstring of `ESCN.__init__()`
@fkuehlein fkuehlein linked a pull request Jul 3, 2024 that will close this issue
fkuehlein added a commit that referenced this issue Jul 3, 2024
DOC: add `EventSeriesClimateNetwork` to API docs (#220)
@fkuehlein fkuehlein changed the title DOC: Add EventSeriesClimateNetwork to API documentation DOC: sphinx Didn't find <class attribute> in <module> when building docs Jul 3, 2024
@fkuehlein
Copy link
Collaborator Author

The original issue has been resolved as of #232, but the issue in the above comment persists, although it is only a matter of having a clean build log.

@fkuehlein fkuehlein reopened this Jul 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance something should be improved or is outdated
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant