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

docs: API reference review #932

Merged
merged 19 commits into from
Aug 29, 2024
Merged

docs: API reference review #932

merged 19 commits into from
Aug 29, 2024

Conversation

sdiazlor
Copy link
Contributor

@sdiazlor sdiazlor commented Aug 27, 2024

Changes

  • Configured API references, added missing steps/sections and updated docstrings to render them correctly
  • Removed individual LLM Gallery for better maintainability, as there were missing LLMs.
  • Minor update to regex in parse_google_docstring used in component_gallery.py, so that examples are rendered in API references and component_gallery
  • Added basic contributor docs
  • Changed OpenAI in quickstart and README by HF Inference Endpoints.

FYI

  • If using \n in examples, it breaks the rendering in docs, so better to use \\n
  • Examples should be written without a blank line as:
Examples:
    Bla bla bla
    
    ```python
    pass
    ```

Copy link

Documentation for this PR has been built. You can view it at: https://distilabel.argilla.io/pr-932/

@sdiazlor sdiazlor changed the title docs: add tags for api docs: API reference review Aug 27, 2024
Copy link

codspeed-hq bot commented Aug 27, 2024

CodSpeed Performance Report

Merging #932 will not alter performance

Comparing docs/885-docs-add-tags-for-api (7223d76) with develop (bb14e8b)

Summary

✅ 1 untouched benchmarks

@davidberenstein1957
Copy link
Member

davidberenstein1957 commented Aug 29, 2024

@sdiazlor would you be able to add a google colab button to the first page of the docs, to one of the notebooks you will present during the community?
both
https://distilabel.argilla.io/latest/sections/getting_started/quickstart/
and
https://distilabel.argilla.io/latest/

@sdiazlor sdiazlor merged commit 88615c7 into develop Aug 29, 2024
7 checks passed
@sdiazlor sdiazlor deleted the docs/885-docs-add-tags-for-api branch August 29, 2024 13:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants