Skip to content
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 51 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: Documentation Build
on:
push:
branches: [ main ]
pull_request:
types: [ opened, synchronize ]

jobs:
build-docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2

# Checkout documentation repository
- name: Checkout Docs Repository
uses: actions/checkout@v2
with:
repository: qojulia/QuantumOptics.jl-documentation
path: docs-repo

# Setup Julia environment
- name: Setup Julia
uses: julia-actions/setup-julia@v1
with:
version: '1.x'

# Install dependencies
- name: Install Dependencies
run: |
cd docs-repo
julia --project=. -e '
using Pkg
Pkg.instantiate()
Pkg.develop(PackageSpec(path=pwd()))
Pkg.build("Documenter")
'

# Build documentation
- name: Build Documentation
run: |
cd docs-repo
julia --project=. make.jl

# Run doctests
- name: Run Doctests
run: |
cd docs-repo
julia --project=. -e '
using Documenter
Documenter.doctest("QuantumOpticsBase"; manual=true)
'