Skip to content

Merge pull request #182 from gdsfactory/improve_ring_docs #148

Merge pull request #182 from gdsfactory/improve_ring_docs

Merge pull request #182 from gdsfactory/improve_ring_docs #148

Workflow file for this run

name: Sphinx docs to gh-pages
on:
push:
branches:
- main
workflow_dispatch:
jobs:
build-docs:
runs-on: ubuntu-latest
name: Sphinx docs to gh-pages
steps:
- uses: actions/checkout@v4
- uses: actions/cache@v3
with:
path: |
~/.gdsfactory/
key: 0.0.1
restore-keys: 0.0.1
- uses: conda-incubator/setup-miniconda@v2
with:
python-version: '3.10'
mamba-version: "*"
conda-version: '23.7.4'
channels: conda-forge,defaults
channel-priority: true
activate-environment: anaconda-client-env
- name: Add conda to system path
run: |
echo $CONDA/bin >> $GITHUB_PATH
- name: Install dependencies
run: |
make dev
- name: make docs
env:
SIMCLOUD_APIKEY: ${{ secrets.SIMCLOUD_APIKEY }}
GDSFACTORY_DISPLAY_TYPE: klayout
KFACTORY_DISPLAY_TYPE: image
run: |
make docs
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
path: "./docs/_build/html/"
deploy-docs:
needs: build-docs
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2