Docs

Merge pull request #117 from Point72/tkp/llms #79

	name: Docs
	on:
	push:
	branches: ["main"]
	tags: ["v*"]
	workflow_dispatch:
	permissions:
	contents: write
	jobs:
	docs:
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v6

	- name: Set up Python
	uses: actions/setup-python@v6
	with:
	python-version: '3.11'
	cache: pip
	cache-dependency-path: pyproject.toml

	- name: Install Rust
	uses: dtolnay/rust-toolchain@stable

	- name: Setup Node.js
	uses: actions/setup-node@v6
	with:
	node-version: '20'

	- name: Install JSDoc/TypeDoc
	run: npm install -g jsdoc typedoc

	- name: Install doxygen
	run: sudo apt-get install -y doxygen

	# Build with the working copy (not the released yardang) so that the docs,
	# and the per-theme previews below, exercise the version in this repo.
	- name: Install self
	run: pip install -e .[develop]

	- name: Build docs
	run: yardang build

	# Render the full site once per bundled theme into docs/html/_previews/<theme>/
	# so each theme is browsable live at a suburl of the published site.
	- name: Build theme previews
	run: yardang preview

	- name: Publish to GitHub Pages
	uses: peaceiris/actions-gh-pages@84c30a85c19949d7eee79c4ff27748b70285e453 # v4.1.0
	with:
	github_token: ${{ secrets.GITHUB_TOKEN }}
	publish_branch: gh-pages
	publish_dir: docs/html
	force_orphan: true

	- name: Build Wiki
	run: yardang wiki --output-dir docs/wiki

	- name: Upload Documentation to Wiki
	uses: Andrew-Chen-Wang/github-wiki-action@v5
	with:
	path: docs/wiki

Provide feedback