8 Commits

Author	SHA1	Message	Date
Massimiliano Pippi	4efe40664c	use haystack-pydoc-tools package instead of local code (#6818)	2024-01-23 18:28:52 +01:00
Daria Fokina	3fedd9f67f	docs: add Data Classes API ref and cleanup (#6482) ... * Data Classes and cleanup * Update pydoc-markdown.sh * Update converter.yml	2023-12-04 14:03:28 +01:00
Julian Risch	db36d6277a	docs: Add readme sync for API docs 2.0 (#6173) ... * add sync docs for preview * add example config for audio docs * hardcode version in renderer * use custom renderer for preview docs * update comment and excerpt	2023-10-27 14:53:03 +02:00
Massimiliano Pippi	1498aacc77	chore: make the docs generator runnable without an API key (#4405) ... * spit a warning instead of exiting * print which file is being converted (useful to debug CI) * pin docspec for the time being	2023-03-14 16:15:19 +01:00
Massimiliano Pippi	8824f3a10a	re-organize pydoc config files (#4042)	2023-02-03 12:51:10 +01:00
Massimiliano Pippi	0c1de3745d	fix milvus imports (#3576)	2022-11-15 10:58:51 +01:00
Branden Chan	492a8046d8	docs: sync Haystack API with Readme (#3223) ... * First pass at syncing Haystack API with Readme * Reapply changes * Regularize slugs * Regularize slugs * Regularize slugs * Set category id and regen * Trigger workflow * Delete old md files * Test sync * Undo test string * Incorporate reviewer feedback * Test on the fly API generation and sync * Test on the fly API generation and sync * Test on the fly API generation and sync * Test on the fly API generation and sync * Test on the fly API generation and sync * Change name of pydoc-markdown scripts * Test on the fly API generation and sync * Remove version tag * Test version tag * Test version tag * Test version tag * Revert test docstring * Revert md file changes * Revert md file changes * Revert script naming * Test on the fly generation and sync * Adjust for on the fly generation and sync * Revert test string * Remove old documentation workflow * Set workflow to work on main * Change readme version name	2022-09-21 17:18:34 +02:00
Sara Zan	2d65c380f1	pre-commit hooks (#2819) ... * Add pre-commit config * update contributing guidelines * try failing the workflow * add pre-commit to the deps * updating uninstall instructions * separate jobs in CI * make tutorials check fail * make black check fail * make openapi check fail * make yaml schema and api docs checks fail * highlight the instructions * Update .pre-commit-config.yaml Co-authored-by: Tobias Wochinger <mail@tobias-wochinger.de> * Update CONTRIBUTING.md Co-authored-by: Tobias Wochinger <mail@tobias-wochinger.de> * Update CONTRIBUTING.md Co-authored-by: Tobias Wochinger <mail@tobias-wochinger.de> * Use black --check * Add images of the CI * title level * feedback Co-authored-by: Tobias Wochinger <mail@tobias-wochinger.de>	2022-07-26 15:02:15 +02:00