Python hosted documentation

[brunoocasali]

Following the integration-guides issue #201 we must implement the automatic documentation in this SDK.

• Decide which module will be used, good reference which compares multiple alternatives.
• Implement it based on these constraints:
  • Should base the documentation on the code comments
  • Should be run automatically
  • Should be run automatically from the CI
  • Should be hosted in a meilisearch.com subdomain or in the python community docs hosting like the meilisearch-rust.

[kaggrwal]

@brunoocasali @alallema

I have tried creating some documentation here. I have hosted it here meilisearch-python-docs

Kindly check and let me know if this is what we are trying to achieve in this issue.
You can let me know the improvements, i will fix them and will proceed for publishing on subdomain/community.

If everything is fine, kindly guide me regarding the CI pipeline being used here or how can i push these documents to a subdomain of meilisearch.com (hosting info and all).

Thanks

[alallema]

Hi @kaggrwal,
This is exactly the kind of thing we would like 🤩 !!!
How did you generate this documentation, does a GitHub Action exist for this or would it be possible to implement that in a CI? Could we consider hosting this documentation directly on a GitHub page?
Thanks again for contributing with Meilisearch ❤️
If you are participating in Hacktoberfest, and you would like to receive a small gift from Meilisearch too, don't forget to fill this form.

[kaggrwal]

Hi @alallema, Glad to hear you liked this solution :)

Regarding publishing of this, let me explore which way would be the best one and probably the easiest one to integrate with the current structure. I'll surely provide a solution within two days. Again, thanks for this opportunity :)

[alallema]

Thanks to you @kaggrwal, and don't hesitate if you have any questions.

[kaggrwal]

Hi @alallema and @brunoocasali,

I have pushed the changes, and added a github action also.
This will generate the documentation and will publish it to the github pages. example

Things to do before merging:

• Change the branch name in documentation.yml, which would trigger the documentation action
  Attached Screenshot, you can see branch name '462_python_hosted_documentation' in two places.

Things to After merging:

• Enable git pages for the repository and select deploy from gh-pages branch with root location
  Attached Screenshot, see the settings for pages

This was really a challenging one, thanks for providing me opportunity to work on this, i learnt something new with this,
Let me know if there is any improvement required in this or if you face any issues in this.

[alallema]

Hi @kaggrwal,
Thank you so much for this amazing job 😍 !!! It's really really cool 🤩
I have a question:

Change the branch name in documentation.yml, which would trigger the documentation action
Attached Screenshot, you can see branch name '462_python_hosted_documentation' in two places.

Did you mean I have to create a branch called 462_python_hosted_documentation in this repository and change the base branch of your PR to this new branch?

[kaggrwal]

Hi @kaggrwal, Thank you so much for this amazing job heart_eyes !!! It's really really cool star_struck I have a question:

Change the branch name in documentation.yml, which would trigger the documentation action
Attached Screenshot, you can see branch name '462_python_hosted_documentation' in two places.

Did you mean I have to create a branch called 462_python_hosted_documentation in this repository and change the base branch of your PR to this new branch?

@alallema There is no need to change the base branch, I have modified the documentation action to get triggered , so whenever any change will be pushed to main branch, documentation would be regenerated.
Suppose, if someone has added new module or new file or changed some code, documentation would be regenerated in that case.

You can merge it and , take the steps that i have mention after merging, and from the next commit in main branch you would be able to see the documentation.