8 Commits

Author	SHA1	Message	Date
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
Silvano Cerza	9a359101fd	chore: Rework docs generation (#5481) ... * Change docs generation to use id for parent doc instead of slug * Rename step	2023-08-01 12:18:33 +02:00
Silvano Cerza	d6f855cbc5	chore: Add support for hierarchical docs (#5278) ... Co-authored-by: bogdankostic <bogdankostic@web.de>	2023-07-07 17:00:29 +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
Silvano Cerza	ee74421212	ci: Refactor docs config and generation (#4280) ... * Change docs yml category config * Update docs renderers to fetch categories from Readme.io * Update readme_sync.yml to handle new docs rendering * Remove unecessary script and related workflow step * Fix sys.exits	2023-03-01 09:51:02 +01:00
Massimiliano Pippi	7f6ed941d4	chore: bump pydoc-markdown version used in the CI (#3955) ... * use latest pydoc-markdown * make the workflow manually actionable * Apply suggestions from code review Co-authored-by: Silvano Cerza <3314350+silvanocerza@users.noreply.github.com> Co-authored-by: Silvano Cerza <3314350+silvanocerza@users.noreply.github.com>	2023-01-26 16:58:43 +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
Massimiliano Pippi	8ee2b6b403	Add a custom pydoc renderer for Readme.io (#2825) ... * add custom pydoc renderer * create an example * revert example code	2022-07-22 10:43:51 +02:00