Setup for doc-builder and added TOC

This commit is contained in:
Merve Noyan 2023-07-31 14:18:20 +03:00 committed by GitHub
parent 92bb56b0c1
commit dc631b5be5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 69 additions and 0 deletions

View File

@ -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 }}

View File

@ -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

View File

@ -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 }}

21
docs/source/_toctree.yml Normal file
View File

@ -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