mirror of
https://github.com/agentscope-ai/ReMe.git
synced 2026-09-07 08:26:06 +00:00
generate docs automatically
This commit is contained in:
parent
40d138d41d
commit
54f3bbf539
1 changed files with 40 additions and 0 deletions
40
.github/workflows/deploy_sphinx_docs.yml
vendored
Normal file
40
.github/workflows/deploy_sphinx_docs.yml
vendored
Normal file
|
|
@ -0,0 +1,40 @@
|
|||
name: Deploy Sphinx documentation to Pages
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
types: [opened, synchronize]
|
||||
paths:
|
||||
- 'docs/sphinx_doc/**/*'
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
|
||||
jobs:
|
||||
pages:
|
||||
runs-on: ubuntu-20.04
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
- name: Setup Python ${{ matrix.python-version }}
|
||||
uses: actions/setup-python@master
|
||||
with:
|
||||
python_version: ${{ matrix.python-version }}
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
python -m pip install --upgrade pip
|
||||
pip install -r docs/sphinx_doc/requirements.txt
|
||||
- id: build
|
||||
name: Build Documentation
|
||||
run: |
|
||||
cd docs/sphinx_doc
|
||||
bash build_sphinx_doc.sh
|
||||
- name: Upload Documentation
|
||||
uses: actions/upload-artifact@v3
|
||||
with:
|
||||
name: SphinxDoc
|
||||
path: 'docs/sphinx_doc/build/html'
|
||||
- uses: peaceiris/actions-gh-pages@v3
|
||||
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
|
||||
with:
|
||||
github_token: ${{ secrets.GITHUB_TOKEN }}
|
||||
publish_dir: 'docs/sphinx_doc/build/html'
|
||||
Loading…
Add table
Reference in a new issue