From 513a3c56573f2d5bb81762a18be38011b0c3fb24 Mon Sep 17 00:00:00 2001 From: coyotte508 Date: Mon, 17 Jun 2024 16:39:18 +0200 Subject: [PATCH] fix docs --- docs/_toctree.yml | 2 +- packages/doc-internal/package.json | 4 +++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/_toctree.yml b/docs/_toctree.yml index ddbdd7661..948c70e79 100644 --- a/docs/_toctree.yml +++ b/docs/_toctree.yml @@ -30,4 +30,4 @@ isExpanded: true sections: - local: gguf/README - title: Use the GGUF parser + title: Parse local and remote GGUF files diff --git a/packages/doc-internal/package.json b/packages/doc-internal/package.json index 0ddba04de..e23178764 100644 --- a/packages/doc-internal/package.json +++ b/packages/doc-internal/package.json @@ -5,7 +5,7 @@ "description": "Package to generate doc for other @huggingface packages", "private": true, "scripts": { - "start": "pnpm run fix-cdn-versions && pnpm run doc-hub && pnpm run doc-inference && pnpm run doc-agents && cp ../../README.md ../../docs/index.md && pnpm run update-toc && pnpm run fix-md-links && pnpm run fix-md-headinghashlinks", + "start": "pnpm run fix-cdn-versions && pnpm run doc-hub && pnpm run doc-inference && pnpm run doc-agents && pnpm run doc-space-header && pnpm run doc-gguf && cp ../../README.md ../../docs/index.md && pnpm run update-toc && pnpm run fix-md-links && pnpm run fix-md-headinghashlinks", "lint": "eslint --quiet --fix --ext .cjs,.ts .", "lint:check": "eslint --ext .cjs,.ts .", "format": "prettier --write .", @@ -13,6 +13,8 @@ "doc-hub": "typedoc --tsconfig ../hub/tsconfig.json --githubPages false --plugin typedoc-plugin-markdown --out ../../docs/hub --hideBreadcrumbs --hideInPageTOC --sourceLinkTemplate https://github.com/huggingface/huggingface.js/blob/main/{path}#L{line} ../hub/index.ts", "doc-inference": "typedoc --tsconfig ../inference/tsconfig.json --githubPages false --plugin typedoc-plugin-markdown --out ../../docs/inference --hideBreadcrumbs --hideInPageTOC --sourceLinkTemplate https://github.com/huggingface/huggingface.js/blob/main/{path}#L{line} ../inference/src/index.ts", "doc-agents": "typedoc --tsconfig ../agents/tsconfig.json --githubPages false --plugin typedoc-plugin-markdown --out ../../docs/agents --hideBreadcrumbs --hideInPageTOC --sourceLinkTemplate https://github.com/huggingface/huggingface.js/blob/main/{path}#L{line} ../agents/src/index.ts", + "doc-gguf": "mkdir -p ../../docs/gguf && cp ../../packages/gguf/README.md ../../docs/gguf/index.md", + "doc-space-header": "mkdir -p ../../docs/space-header && cp ../../packages/space-header/README.md ../../docs/space-header/index.md", "update-toc": "tsx update-toc.ts", "fix-cdn-versions": "tsx fix-cdn-versions.ts", "fix-md-links": "tsx fix-md-links.ts",