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

Install alibi-detect during RTD docs build #499

Closed
wants to merge 3 commits into from
Closed

Install alibi-detect during RTD docs build #499

wants to merge 3 commits into from

Conversation

ascillitoe
Copy link
Contributor

@ascillitoe ascillitoe commented May 6, 2022

With the ReadTheDocs V2 config file it appears we can install alibi-detect (and its dependencies) as part of the docs build, so that they don't have to be mocked. This is a bit of a waste of compute whilst we have heavy core deps like tensorflow, but once the optional deps project is complete we can investigate installing alibi-detect on RTD and only mocking heavy optional deps (e.g. tensorflow, torch). This would ease pain points experienced when building the API docs involving some mocked modules such as pydantic.

Opening this PR now to come back to once the optional deps project is complete.

If going ahead with this we'd likely have to configure :inherited-members: to prevent docstrings of inherited modules being included when we don't want them to e.g. see example here.

@ascillitoe ascillitoe changed the title Update readthedocs.yml [WIP] Update readthedocs.yml May 6, 2022
@ascillitoe ascillitoe changed the title [WIP] Update readthedocs.yml [WIP] Install alibi-detect during RTD docs build May 6, 2022
@ascillitoe
Copy link
Contributor Author

ascillitoe commented May 6, 2022

This change might also allow us to https://autodoc-pydantic.readthedocs.io/en/stable/index.html to prettify our pydantic model api docs. This package doesn't appear to work properly if pydantic, or any modules used as types in model fields, are mocked... (although this would depend what is mocked...)

@ascillitoe ascillitoe changed the title [WIP] Install alibi-detect during RTD docs build Install alibi-detect during RTD docs build Aug 10, 2022
@ascillitoe ascillitoe added the WIP PR is a Work in Progress label Aug 10, 2022
@ascillitoe ascillitoe closed this by deleting the head repository Apr 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
WIP PR is a Work in Progress
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant