Skip to content

#462 python hosted documentation #546

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
Merged
merged 12 commits into from
Oct 10, 2022
Merged

#462 python hosted documentation #546

merged 12 commits into from
Oct 10, 2022

Conversation

kaggrwal
Copy link
Contributor

@kaggrwal kaggrwal commented Oct 6, 2022

Pull Request

Related issue

Fixes #462

What does this PR do?

  • ...

PR checklist

Please check if your PR fulfills the following requirements:

  • [✓ ] Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
  • [ ✓] Have you read the contributing guidelines?
  • [ ✓] Have you made sure that the title is accurate and descriptive of the changes?

Thank you so much for contributing to Meilisearch!

@kaggrwal
Copy link
Contributor Author

kaggrwal commented Oct 7, 2022

@alallema Can you please run the checks again, as i have removed the slashes that were causing issues with pylint,

sanders41
sanders41 reviewed Oct 8, 2022
View reviewed changes
@sanders41
Copy link
Collaborator

When I run make html I get a warning

WARNING: html_static_path entry '_static' does not exist

It looks like everything still build OK though.

@kaggrwal
Copy link
Contributor Author

kaggrwal commented Oct 10, 2022 •
edited
Loading

When I run make html I get a warning

WARNING: html_static_path entry '_static' does not exist

It looks like everything still build OK though.

It will run fine, this path is for custom static content like HTML and css, if someone wants to add it apart from the one generated by sphinx. For now, i have commented it. If it will be required in the future we can uncomment it and use it.

alallema
alallema approved these changes Oct 10, 2022
View reviewed changes
Copy link
Contributor

@alallema alallema left a comment

Choose a reason for hiding this comment

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

Thank you so much for this amazing contribution @kaggrwal 🔥 🔥 🔥
LGTM!
Thanks again for contributing with Meilisearch ❤️
If you are participating in Hacktoberfest, and you would like to receive some swag from Meilisearch too, please complete this form.

@alallema
Copy link
Contributor

bors merge

@alallema alallema added hacktoberfest documentation Improvements or additions to documentation labels Oct 10, 2022
@bors
Copy link
Contributor

bors bot commented Oct 10, 2022

Build succeeded:

@bors bors bot merged commit ca5f199 into meilisearch:main Oct 10, 2022
@alallema
Copy link
Contributor

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.

curquiza
curquiza reviewed Oct 10, 2022
View reviewed changes
.github/workflows/documentation.yml
@@ -20,7 +20,8 @@ jobs:
uses: dschep/install-pipenv-action@v1
- name: Install dependencies
run: pipenv install --dev
- uses: ammaraskar/sphinx-action@master
- name: Build docs
uses: ammaraskar/sphinx-action@master
Copy link
Member

Choose a reason for hiding this comment

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

@meilisearch/integration-team be careful using master tag in github action. If you don't have the choice it's ok, but always prefer alternatives. You can have bad surprise without noticing it with master if the maintainer is merging a buggy commit to master

Copy link
Contributor

Choose a reason for hiding this comment

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

This is the way it gives in the doc, I will check how to use it differently

Copy link
Member

Choose a reason for hiding this comment

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

Yes I saw, that's why I mention to check alternatives (not an emergency, just to warn you)

Copy link
Contributor

Choose a reason for hiding this comment

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

I will open on issue about it

@brunoocasali brunoocasali mentioned this pull request Oct 10, 2022
Merged
@alallema alallema mentioned this pull request Oct 10, 2022
Closed
bors bot added a commit that referenced this pull request Oct 10, 2022
@bors @brunoocasali @alallema
Merge #549
15dcece 
549: Add new docs links to pypi.org r=alallema a=brunoocasali

After #546 we have now an automated documentation link, we should be able to say that to the user.

Co-authored-by: Bruno Casali <[email protected]>
Co-authored-by: Amélie <[email protected]>
@alallema alallema mentioned this pull request Oct 10, 2022
Merged
@alallema alallema added the enhancement New feature or request label Oct 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@alallema alallema alallema approved these changes

@curquiza curquiza curquiza left review comments

@sanders41 sanders41 sanders41 left review comments

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Python hosted documentation
4 participants
@kaggrwal @sanders41 @alallema @curquiza