Repository navigation

Docs

Preserve declaration order in @with_parameters constructor arguments … #53

	name: Docs

	on:
	push:
	branches:
	- main
	paths:
	- "docs/**"
	- "ext/**"
	- "src/**"
	- "*.toml"
	- ".github/workflows/Docs.yml"
	tags: ["*"]
	pull_request:
	branches:
	- main
	paths:
	- "docs/**"
	- "ext/**"
	- "src/**"
	- "*.toml"
	- ".github/workflows/Docs.yml"
	types: [opened, synchronize, reopened]

	concurrency:
	# Skip intermediate builds: always.
	# Cancel intermediate builds: only if it is a pull request build.
	group: ${{ github.workflow }}-${{ github.ref }}
	cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}

	jobs:
	docs:
	name: Documentation
	runs-on: ubuntu-latest
	permissions:
	actions: write
	contents: write
	statuses: write
	steps:
	- uses: actions/checkout@v6
	- uses: julia-actions/setup-julia@v3
	with:
	version: "1.11.5"
	- name: Use Julia cache
	uses: julia-actions/cache@v3
	with:
	cache-name: docs
	- name: Install dependencies
	shell: julia --project=docs --color=yes {0}
	run: \|
	using Pkg
	Pkg.instantiate()
	- name: Run doctests
	run: julia --color=yes --project=docs docs/make.jl
	env:
	BC_DOCS_DOCTEST_ONLY: "true"
	- name: Generate Literate pages
	run: julia --color=yes --project=docs docs/generate_literate.jl
	- name: Build and deploy
	run: julia --color=yes --project=docs docs/make.jl
	env:
	JULIA_PKG_SERVER: ""
	GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
	DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}