Docs

Render post-install pages for Windows when input is a string (#904) #702

	name: Docs

	on:
	# Runs on pushes targeting the default branch
	push:
	branches: ["main"]
	pull_request:
	paths:
	- ".github/workflows/docs.yml"
	- "docs/**"
	- "CONSTRUCT.md"
	- "constructor/construct.py"

	# Allows you to run this workflow manually from the Actions tab
	workflow_dispatch:

	# Allow one concurrent deployment
	concurrency:
	group: pages-${{ github.workflow }}-${{ github.event.pull_request.number }}
	cancel-in-progress: true

	jobs:
	docs:
	runs-on: ubuntu-latest
	defaults:
	run:
	shell: bash -el {0}
	steps:
	- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

	- uses: conda-incubator/setup-miniconda@d2e6a045a86077fb6cad6f5adf368e9076ddaa8d # v3.1.0
	with:
	activate-environment: constructor-docs
	environment-file: docs/environment.yml
	python-version: '3.11'
	auto-activate-base: false

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

	- name: Upload artifact
	uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3.0.1
	with:
	# Upload entire repository
	path: 'docs/_build/dirhtml'

	pages:

	runs-on: ubuntu-latest
	if: github.event_name != 'pull_request' && 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@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5

Provide feedback