[Add] docs for trouble shooting (#38) #21
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Deploy Sphinx Docs to GCS | |
| on: | |
| push: | |
| branches: | |
| - 'main' | |
| paths: | |
| - 'docs/**' | |
| - '.github/workflows/build_doc.yml' | |
| jobs: | |
| build-and-deploy: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout Source Repository | |
| uses: actions/checkout@v4 | |
| - name: Set Up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.11' | |
| - name: Install Dependencies | |
| run: | | |
| pip install sphinx | |
| pip install sphinx-rtd-theme | |
| pip install alabaster | |
| pip install furo | |
| - name: Build Sphinx Documentation | |
| run: | | |
| cd docs | |
| make html | |
| continue-on-error: false | |
| - name: Add .nojekyll | |
| run: | | |
| touch docs/build/html/.nojekyll | |
| - name: Sync to GCS Bucket | |
| uses: patrickwyler/gcs-bucket-sync-action@1.4 | |
| with: | |
| secrets: ${{ secrets.GOOGLE_SERVICE_ACCOUNT_CREDENTIALS }} | |
| bucket: 'docs.tensormesh.ai' | |
| sync_dir_from: 'docs/build/html' | |
| sync_dir_to: 'lmignite' # ← upload under lmignite/ prefix | |
| exclude: '.*\.md$|\.gitignore$|\.git/.*$|\.github/.*$' |