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

feat: Generate API docs #262

Merged
merged 10 commits into from
Jan 25, 2024
Merged

feat: Generate API docs #262

merged 10 commits into from
Jan 25, 2024

Conversation

masci
Copy link
Contributor

@masci masci commented Jan 24, 2024

Add a hatch command hatch run docs to run pydoc-markdown and generate the markdown file containing the API docs for the integration.

@masci masci requested a review from a team as a code owner January 24, 2024 17:07
@masci masci requested review from vblagoje and removed request for a team January 24, 2024 17:07
@vblagoje
Copy link
Member

When I run this branch I get:

(haystack) ➜  chroma git:(massi/chroma-pydoc) ✗ hatch run docs
cmd [1] | pydoc-markdown pydoc/document_stores.yml
/Users/vblagoje/Library/Application Support/hatch/env/virtual/chroma-haystack/bdNP9TFm/chroma-haystack/lib/python3.10/site-packages/haystack_pydoc_tools/renderers.py:60: UserWarning: README_API_KEY env var is not set, using a placeholder category ID
  self.categories = self._readme_categories(self.version)

I suppose the key README_API_KEY is required. LMK if I can be of any help here 😄

@masci masci requested a review from dfokina January 25, 2024 15:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants