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

No API for CornerPlotter showing on documentation page #306

Closed
sguillot opened this issue Apr 20, 2023 · 4 comments · Fixed by #346
Closed

No API for CornerPlotter showing on documentation page #306

sguillot opened this issue Apr 20, 2023 · 4 comments · Fixed by #346
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@sguillot
Copy link
Contributor

There are some examples of CornerPlotter in the tutorials, but the full API does not show on this page: https://xpsi-group.github.io/xpsi/postprocessing.html

@sguillot sguillot added the documentation Improvements or additions to documentation label Apr 20, 2023
@thjsal
Copy link
Contributor

thjsal commented Apr 20, 2023

I think that page mostly shows the docstrings for all the CornerPlotter methods. Is there something specific that you find missing there?

Or you were expecting to see more examples of how to use the methods, as in here: https://xpsi-group.github.io/xpsi/Post-processing.html?

@sguillot
Copy link
Contributor Author

I think that page mostly shows the docstrings for all the CornerPlotter methods. 

That's the thing, it doesn't show the docstring of CornerPlotter, only for SignalPlotter, ResidualPlotter, PulsePlot, SpectrumPlot

@thjsal
Copy link
Contributor

thjsal commented Apr 20, 2023

I see you are right! Need to check why that is so.

@thjsal
Copy link
Contributor

thjsal commented Apr 20, 2023

The Cornerplotter API actually shows up when I compile the documentation locally on my laptop. So for some reason, GitHub does not compile it in the same way.

EDIT: When building the docs with GitHub, the error message is found here:
https://github.com/xpsi-group/xpsi/actions/runs/4797999226/jobs/8535691118

It mostly says that AttributeError: module 'xpsi.PostProcessing' has no attribute 'CornerPlotter', but it is not clear to me why. Other similar-looking attributes work fine, and all of them work without errors or warnings when compiling on my laptop. Maybe some small differences in the software versions used to compile the documentation.

@thjsal thjsal self-assigned this Nov 10, 2023
@thjsal thjsal linked a pull request Nov 10, 2023 that will close this issue
@thjsal thjsal linked a pull request Nov 10, 2023 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants