search

xpsi-group / xpsi

X-PSI: X-ray Pulse Simulation and Inference
Other
34 stars 21 forks source link

No API for CornerPlotter showing on documentation page #306

Closed sguillot closed 10 months ago

sguillot commented 1 year ago

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

thjsal commented 1 year ago

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 commented 1 year ago 
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 commented 1 year ago

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

thjsal commented 1 year ago

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.