Skip to content

Fix - modules documentation are not generated properly #553

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

Merged
merged 5 commits into from
Oct 11, 2022
Merged

Fix - modules documentation are not generated properly #553

merged 5 commits into from
Oct 11, 2022

Conversation

alallema
Copy link
Contributor

@alallema alallema commented Oct 10, 2022

Some module wasn't generated because of this error:

WARNING: autodoc: failed to import module 'client' from module 'meilisearch'; the following exception was raised:
No module named 'camel_converter'

@alallema alallema closed this Oct 10, 2022
@alallema alallema reopened this Oct 10, 2022
@alallema alallema changed the title Try trigger documentation build Fix module doesn't generated because of missing dependency Oct 11, 2022
@alallema alallema requested a review from bidoubiwa October 11, 2022 10:37
sanders41
sanders41 previously approved these changes Oct 11, 2022
Copy link
Collaborator

@sanders41 sanders41 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is interesting, I didn't get this error when I built locally. If this doesn't work I would try building the docs with the make command instead of using the ammaraskar/sphinx-action action and see if the problem is specific to that.

@alallema
Copy link
Contributor Author

Hi @sanders41,
Thanks, I have it locally when I run this command, but it also appears on the action here.
This config seems to fix the issue:
autodoc_mock_imports = ["camel_converter"]
But do you think it would be better to remove completely ammaraskar/sphinx-action and replace it with make command?

Also, thank you for your review yesterday on this repository. Like last year, we propose to send gifts for Hacktoberfest. Even if you don't participate officially in the fest as a great contributor of Meilisearch if you want to receive some swag don't hesitate to fill out this form. :rougir: (modifié)

@sanders41
Copy link
Collaborator

The action itself seems fine, but I saw there was some concern with it using the master branch. It doesn't look like they tagged the latest release in a way that it could be referenced in the action so using make seems like the only real solution if you want to move off master.

Copy link
Contributor

@bidoubiwa bidoubiwa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The title of the PR is not very clear and is not correct english. Maybe it is worth mentioning that it is about the documentation.

@alallema alallema changed the title Fix module doesn't generated because of missing dependency Fix the documentation modules are not generated properly Oct 11, 2022
@alallema alallema changed the title Fix the documentation modules are not generated properly Fix - documentation modules are not generated properly Oct 11, 2022
@alallema
Copy link
Contributor Author

@sanders41, I have added it to the problem I have already created about it.
Thank you for your advice I will try to merge it like that for now and modify it when I will have time

@alallema alallema requested a review from bidoubiwa October 11, 2022 12:20
@bidoubiwa bidoubiwa changed the title Fix - documentation modules are not generated properly Fix - modules documentation are not generated properly Oct 11, 2022
Copy link
Contributor

@bidoubiwa bidoubiwa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🔥

@alallema
Copy link
Contributor Author

bors merge

@bors
Copy link
Contributor

bors bot commented Oct 11, 2022

@bors bors bot merged commit 10bdad1 into main Oct 11, 2022
@bors bors bot deleted the test-doc branch October 11, 2022 12:49
@alallema
Copy link
Contributor Author

This message is sent automatically

Thanks again for contributing to Meilisearch ❤️
If you are participating in Hacktoberfest, and you would like to receive some gift from Meilisearch too, please complete this form.

@alallema alallema added the skip-changelog The PR will not appear in the release changelogs label Oct 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-changelog The PR will not appear in the release changelogs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants