From d29e826f2c0db3993edfee7f2b07261648c968a4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=B8=B8=E9=9B=81?= Date: Mon, 24 Jul 2023 21:33:41 +0800 Subject: [PATCH] docs --- .github/workflows/main.yml | 4 ++++ docs/index.rst | 4 ++-- docs/qick_start.md => funasr/quick_start.md | 0 {docs => funasr}/quick_start_zh.md | 0 4 files changed, 6 insertions(+), 2 deletions(-) rename docs/qick_start.md => funasr/quick_start.md (100%) rename {docs => funasr}/quick_start_zh.md (100%) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 9f3d9bede..32cc242da 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -13,6 +13,10 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v1 + - name: cp funasr + if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/dev_wjm' || github.ref == 'refs/heads/dev_lyh' + run: | + ln -s funasr ./ - uses: ammaraskar/sphinx-action@master with: docs-folder: "docs/" diff --git a/docs/index.rst b/docs/index.rst index 1495645ac..b03536df6 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -21,10 +21,10 @@ Overview ./installation/docker.md .. toctree:: - :maxdepth: 1 + :maxdepth: 5 :caption: Quick Start - ./qick_start.md + ./funasr/quick_start.md .. toctree:: :maxdepth: 1 diff --git a/docs/qick_start.md b/funasr/quick_start.md similarity index 100% rename from docs/qick_start.md rename to funasr/quick_start.md diff --git a/docs/quick_start_zh.md b/funasr/quick_start_zh.md similarity index 100% rename from docs/quick_start_zh.md rename to funasr/quick_start_zh.md