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.

Sign up for GitHub

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

Jump to bottom

[docs] Optional classes are not documented #1082

Open
paxcema opened this issue Dec 15, 2022 · 0 comments
Open

[docs] Optional classes are not documented #1082

paxcema opened this issue Dec 15, 2022 · 0 comments
Assignees
@paxcema
Labels
enhancement New feature or request

Comments

@paxcema
Copy link
Member

paxcema commented Dec 15, 2022

The automated doc system is not picking up the docstrings in classes that require optional dependencies. For example, the mixers LightGBM, LightGBMArray and NHitsMixer.

We should either change the CI to install all extra deps or change the doc system to pick up these classes regardless of whether the dependencies are installed or not.
@paxcema paxcema added the enhancement New feature or request label Dec 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@paxcema paxcema

Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@paxcema