doctest warnings

[henrydingliu]

@genedan @EKtheSage doctest is being passive aggressive and spitting out a metric ton of warnings. Is this intentional? Does it have the potential to break anything

[genedan]

I'm still trying to wrap my head around what parts of the API reference get automatically generated, and which require files to be manually generated. So my approach might change as we learn more.

I think what's happening is that Sphinx is looking through the folder docs/library/generated and expecting there to be stub files for every single method that it says is missing.

I don't think we should be making all those stub files, I looked at the pandas and scipy folders and it would be impractical to make a file for every single method.

You can set numpydoc_show_class_members = False in the config to suppress these warnings, this would be consistent with what pandas does:

https://github.com/pandas-dev/pandas/blob/3074c5fe262ce528fdba81b58bb70f763ac5d603/doc/source/conf.py#L212

I think the overall toctree is designed manually instead, with the content pulled automatically from the docstrings.

I'm not sure whether we need to add that line to _config.yml or conf.py. Sometimes I've found that I had to put the setting in the first file as it will override whatever is in the second.

[henrydingliu]

copilot suggested numpydoc_class_members_toctree = False in conf.py to suppress the warnings.

i agree that we want to manually make those stub files. however, it leaves the issue of the autosummary of the methods only shows the first line of the docstring. take Development for example, We have richer docstring for fit and transform, but neither is showing up in the summary table.

i think scipy's setup is what we want. each estimator has its page (e.g. logisticregression from scipy, for us it would be development or chainladder). within the page you can see all the parameters, attributes, and methods. pandas has a separate page for each function under series or dataframe, which is probably too crowded for us.

i tried adding :members: to Development.rst but it didn't do anything. Will play around with it more.