API Documentation Missing

[Jan-Willem]

The API documentation (https://xradio.readthedocs.io/en/latest/measurement_set/api.html) is missing for:

        convert_msv2_to_processing_set,
        estimate_conversion_memory_and_cores,

I suspect this is due to the conditionals in xradio/src/xradio/measurement_set/init.py

import warnings

from .processing_set_xdt import ProcessingSetXdt
from .open_processing_set import open_processing_set
from .load_processing_set import load_processing_set
from .measurement_set_xdt import MeasurementSetXdt
from .schema import SpectrumXds, VisibilityXds

__all__ = [
    "ProcessingSetXdt",
    "MeasurementSetXdt",
    "open_processing_set",
    "load_processing_set",
    "SpectrumXds",
    "VisibilityXds",
]

try:
    from .convert_msv2_to_processing_set import (
        convert_msv2_to_processing_set,
        estimate_conversion_memory_and_cores,
    )
except ModuleNotFoundError as exc:
    warnings.warn(
        f"Could not import the function to convert from MSv2 to MSv4. "
        f"That functionality will not be available. Details: {exc}",
        UserWarning,
    )
else:
    __all__.extend(
        ["convert_msv2_to_processing_set", "estimate_conversion_memory_and_cores"]
    )

or it might be due to a missing dependency on readthedocs: https://github.com/casangi/xradio/blob/main/docs/sphinx.txt

[FedeMPouzols]

If I build the docs locally with the same command as used in readthedocs, those two functions (module convert_msv2_to_processing_set.py) show up in the generated docs. This is probably an issue with optional dependencies not available in the readthedocs virtualenv.

I recalled that months ago, when python-casacore was pip-optional I had to add it to the readthedocs.yaml: here 114b6fe as an extra_requirement for pip.
That is obsolete now that we have many more optional (extras) blocks. We can see in the latest readthedocs build logs:

python -m pip install --upgrade --upgrade-strategy only-if-needed --no-cache-dir .[python-casacore]
...
WARNING: xradio 1.1.3 does not provide the extra 'python-casacore'

That needs to be updated to casacore (as a minimum).
Let me create a quick branch to see if this is enough to fix the issue or there are more missing dependencies...

[FedeMPouzols]

Yes, that is enough to fix the issue: https://xradio.readthedocs.io/en/latest/measurement_set/api.html => https://xradio--560.org.readthedocs.build/en/560/measurement_set/api.html

I've opened a PR with that fix.
But note that convert_msv2_to_processing_set.py will also need dask (at least) to be able to import. That is provided by toolviper. But toolviper is installed via the requirements in sphinx.txt. It is not very clear how sphinx.txt and the extras/optional blocks of pyproject.toml overlap/interact. It looks to me like sphinx.txt is a detailed list of frozen version of sphinx (only doc related) dependencies. Perhaps it would be better to not add toolviper in sphinx.txt and do a install of xradio[casacore,zarr] (as extras in the readthedocs.yaml)? The zarr extra add toolviper and also adds other dependencies like psutil, astropy, etc. that are required in image modules.