Skip to content

Add Sphinx Multilingual Support (EN/ZH) and Integrate Markdown Docs; Fix Broken Links #250

Add Sphinx Multilingual Support (EN/ZH) and Integrate Markdown Docs; Fix Broken Links

Add Sphinx Multilingual Support (EN/ZH) and Integrate Markdown Docs; Fix Broken Links #250

name: Deploy Sphinx documentation to Pages
on:
pull_request:
types: [opened, synchronize]
paths:
- 'docs/sphinx_doc/**/*'
push:
branches:
- main
tags:
- '*'
jobs:
pages:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: [ "3.10" ]
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
- 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 -v -e .[dev]
- name: Get git tags
run: |
git fetch --tags origin
git tag
- id: build
name: Build Documentation
run: |
cd docs/sphinx_doc
bash build_doc.sh
- name: Upload Documentation
uses: actions/upload-artifact@v4
with:
name: SphinxDoc
path: 'docs/sphinx_doc/build'
- name: Redirect index.html
run: |
REPOSITORY_OWNER="${GITHUB_REPOSITORY_OWNER}"
cd docs/sphinx_doc
cp ./redirect.html build/index.html
sed -i "s/\[VERSION\]/$(python -c 'import data_juicer;print(data_juicer.__version__)')/g" build/index.html
sed -i "s/\[REPOSITORY_OWNER\]/${REPOSITORY_OWNER}/g" build/index.html
cp build/index.html build/404.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'