-
-
Notifications
You must be signed in to change notification settings - Fork 58
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
Document plot handlers. #838
Comments
I don't know if it is possible to make sphinx document things like Another idea that I have is to gather all plot handlers and create a page in the
with links to the corresponding methods. This information could also be at the beggining of the showcase notebooks. |
I have found a way to get method names with dots: which I think is the most intuitive way for the user. But to achieve this (after hours of trying) I have needed a dirty hack:
If you have a better idea of how to acheive this rendering... |
Methods like
Hamiltonian.plot.pdos()
are not documented anywhere, and the only way of getting information about them is if your editor can show you the arguments and documentation of the function.I want to document them, but I don't know how exactly. I have thought of modifying the class template for autosummary (https://github.com/zerothi/sisl/blame/main/docs/_templates/autosummary/class.rst) to check for the plot attribute and then add some documentation, but I don't know exactly how or if this is the best approach.
The text was updated successfully, but these errors were encountered: