From dc631b5be5b3fc115adbe9e995ec184dc63081a1 Mon Sep 17 00:00:00 2001 From: Merve Noyan Date: Mon, 31 Jul 2023 14:18:20 +0300 Subject: [PATCH] Setup for doc-builder and added TOC --- .github/workflows/build_documentation.yml | 18 +++++++++++++++++ .github/workflows/build_pr_documentation.yml | 16 +++++++++++++++ .github/workflows/delete_doc_comment.yml | 14 +++++++++++++ docs/source/_toctree.yml | 21 ++++++++++++++++++++ 4 files changed, 69 insertions(+) create mode 100644 .github/workflows/build_documentation.yml create mode 100644 .github/workflows/build_pr_documentation.yml create mode 100644 .github/workflows/delete_doc_comment.yml create mode 100644 docs/source/_toctree.yml diff --git a/.github/workflows/build_documentation.yml b/.github/workflows/build_documentation.yml new file mode 100644 index 00000000..24e15b48 --- /dev/null +++ b/.github/workflows/build_documentation.yml @@ -0,0 +1,18 @@ +name: Build documentation + +on: + push: + branches: + - main + - doc-builder* + - v*-release + +jobs: + build: + uses: huggingface/doc-builder/.github/workflows/build_main_documentation.yml@main + with: + commit_sha: ${{ github.sha }} + package: text-generation-inference + secrets: + token: ${{ secrets.HUGGINGFACE_PUSH }} + hf_token: ${{ secrets.HF_DOC_BUILD_PUSH }} \ No newline at end of file diff --git a/.github/workflows/build_pr_documentation.yml b/.github/workflows/build_pr_documentation.yml new file mode 100644 index 00000000..b3e1131d --- /dev/null +++ b/.github/workflows/build_pr_documentation.yml @@ -0,0 +1,16 @@ +name: Build PR Documentation + +on: + pull_request: + +concurrency: + group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }} + cancel-in-progress: true + +jobs: + build: + uses: huggingface/doc-builder/.github/workflows/build_pr_documentation.yml@main + with: + commit_sha: ${{ github.event.pull_request.head.sha }} + pr_number: ${{ github.event.number }} + package: text-generation-inference \ No newline at end of file diff --git a/.github/workflows/delete_doc_comment.yml b/.github/workflows/delete_doc_comment.yml new file mode 100644 index 00000000..8604019d --- /dev/null +++ b/.github/workflows/delete_doc_comment.yml @@ -0,0 +1,14 @@ +name: Delete doc comment + +on: + workflow_run: + workflows: ["Delete doc comment trigger"] + types: + - completed + + +jobs: + delete: + uses: huggingface/doc-builder/.github/workflows/delete_doc_comment.yml@main + secrets: + comment_bot_token: ${{ secrets.COMMENT_BOT_TOKEN }} \ No newline at end of file diff --git a/docs/source/_toctree.yml b/docs/source/_toctree.yml new file mode 100644 index 00000000..1e8d8ac4 --- /dev/null +++ b/docs/source/_toctree.yml @@ -0,0 +1,21 @@ +- sections: + - local: index + title: Text Generation Inference + - local: basic_tutorials/install + title: Installation + - local: quicktour + title: Quick Tour + - local: supported_models + title: Supported Models and Hardware + title: Getting started +- sections: + - local: basic_tutorials/running_locally + title: Running Locally + - local: basic_tutorials/running_docker + title: Running with Docker + - local: basic_tutorials/consuming_TGI + title: Consuming TGI as a backend + - local: basic_tutorials/consuming_TGI + title: Preparing Model for Serving + - local: basic_tutorials/preparing_model + title: Tutorials \ No newline at end of file