Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add public docs #73

Merged
merged 13 commits into from
Dec 12, 2024
64 changes: 64 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
name: Docs

on:
# Runs on pushes targeting the default branch
push:
branches: [main]
pull_request:
paths:
- docs/**
- .github/workflows/docs.yml
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Allow one concurrent deployment
concurrency:
group: pages
cancel-in-progress: true

jobs:
docs:
runs-on: ubuntu-latest
defaults:
run:
shell: bash -el {0}
steps:
- uses: actions/checkout@v3

- uses: conda-incubator/setup-miniconda@v2
travishathaway marked this conversation as resolved.
Show resolved Hide resolved
with:
activate-environment: conda-anaconda-telemetry-docs
environment-file: docs/environment.yml
python-version: '3.12'
auto-activate-base: false

- name: Build Documentation
run: |
cd docs
make dirhtml

- name: Upload artifact
uses: actions/upload-pages-artifact@v1
travishathaway marked this conversation as resolved.
Show resolved Hide resolved
with:
# Upload entire repository
path: docs/_build/dirhtml

pages:
runs-on: ubuntu-latest
if: github.ref == 'refs/heads/main'
needs: [docs]

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1
travishathaway marked this conversation as resolved.
Show resolved Hide resolved
Loading