mlflow module not showing up on the documentation page

[wd60622]

The mlflow module has not been showing up in the documentation even with the merge to the main branch. View the documentation here.

This would want to be added such that it displays.

[wd60622]

Would @OriolAbril understand why this is not showing up?

[OriolAbril]

sphinx autodoc imports the objects it documents, and it is not being able to import it given mlflow is needed but it is not installed in the docs env.

There are two options:

• add mlflow to the doc env
• use autodoc_mock_imports to mock it and avoid the import error

I'd probably try the mock option and check what happens with the docs of autolog, if the decorator modifies the docstrings/methods dynamically it might end up looking weird when that doesn't happen.

[wd60622]

sphinx autodoc imports the objects it documents, and it is not being able to import it given mlflow is needed but it is not installed in the docs env.

There are two options:

• add mlflow to the doc env
• use autodoc_mock_imports to mock it and avoid the import error

I'd probably try the mock option and check what happens with the docs of autolog, if the decorator modifies the docstrings/methods dynamically it might end up looking weird when that doesn't happen.

You are a lifesaver! Will try out these suggestions

[wd60622]

There might be a conflict since the package name is mlflow and our module is also same name. Giving the auto_mock_imports a try first

[wd60622]

Thanks @OriolAbril !