ci: deploy docs via GitHub pages

[RussellSB]

This pull request introduces a new GitHub Actions workflow for automated documentation deployment and significantly simplifies the quickstart sections in both the README.md and documentation. The quickstart now focuses on the core usage pattern, making it easier for new users to get started, while the workflow ensures that documentation is automatically built and deployed when relevant changes are made.

Documentation automation:

• Added a new .github/workflows/docs.yaml workflow that checks if documentation should be deployed based on commit messages and changed files, then builds and deploys the docs to GitHub Pages for both main and develop branches. The workflow also handles branch-specific site URLs and root redirects for the main branch.

Links to full documentation:

• Updated the README.md to direct users to the full documentation site for more information.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

[Copilot]

Pull request overview

Adds automated documentation deployment to GitHub Pages and streamlines the “Quickstart” content to emphasize the core usage flow, while directing readers to the full docs site for detail.

Changes:

• Added a new GitHub Actions workflow to build and deploy MkDocs to gh-pages for main and develop.
• Simplified the README Quickstart and added a link to the hosted documentation.
• Removed the standalone docs/quickstart.md page.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.

File	Description
docs/quickstart.md	Removes the old, verbose quickstart page content.
README.md	Reworks Quickstart to a shorter example and links to the full docs site.
.github/workflows/docs.yaml	Introduces CI workflow to conditionally build & deploy docs to GitHub Pages per-branch.

[Copilot]

README Quickstart no longer includes any installation step (e.g., pip install pytrendy) or a direct link to installation instructions before the first import pytrendy. As-is, a new user can’t successfully follow the Quickstart without prior knowledge; consider adding a minimal install snippet or an explicit link to the installation section in the docs immediately before the code block.

[Copilot]

The Quickstart code sample ends with results.df, but the following block shows the output of results.print_summary() ("Detected:", "Full Results", etc.). This makes the README example internally inconsistent; either call results.print_summary() in the code block (and show that output) or change the displayed output to match what results.df produces.

[Copilot]

CHANGED=$(git diff --name-only HEAD~1 HEAD ...) only compares the last commit against its parent. On pushes that include multiple commits, this can miss relevant changes earlier in the push and incorrectly skip docs deployment. Consider diffing the full push range (e.g., ${{ github.event.before }}..${{ github.sha }}) and/or using fetch-depth: 0 so the history needed for that range is available.

[Copilot]

The workflow decides to deploy based on git log -1 (only the most recent commit message). For pushes containing multiple commits (or when the final commit is a merge commit with a non-semantic subject), this can incorrectly skip deployment even when earlier commits in the same push warrant it. Consider basing the decision on the push payload’s commit list and/or the file-diff range for the entire push, rather than a single commit message.

Suggested change

	fetch-depth: 2
	- name: Determine if docs deployment is needed
	id: check
	run: |
	COMMIT_MSG=$(git log -1 --pretty=%s)
	COMMIT_BODY=$(git log -1 --pretty=%b)
	echo "Commit subject: $COMMIT_MSG"
	# Skip if explicitly flagged
	if echo "$COMMIT_MSG" | grep -q '\[skip docs\]'; then
	echo "Skipping: [skip docs] flag found"
	echo "should_deploy=false" >> $GITHUB_OUTPUT
	exit 0
	fi
	# Always deploy for semantic commit types that affect code or content:
	# feat (minor/major), fix (patch), docs, refactor, perf
	if echo "$COMMIT_MSG" | grep -qE '^(feat|fix|docs|refactor|perf)(\([^)]*\))?!?:'; then
	echo "Deploying: matched semantic commit type"
	echo "should_deploy=true" >> $GITHUB_OUTPUT
	exit 0
	fi
	# Breaking changes (major version bump) — e.g. feat!: or type(scope)!:
	if echo "$COMMIT_MSG" | grep -qE '^[a-z]+(\([^)]*\))?!:'; then
	echo "Deploying: breaking change in subject"
	echo "should_deploy=true" >> $GITHUB_OUTPUT
	exit 0
	fi
	# Breaking change declared in commit body
	if echo "$COMMIT_BODY" | grep -q 'BREAKING CHANGE'; then
	echo "Deploying: BREAKING CHANGE in body"
	echo "should_deploy=true" >> $GITHUB_OUTPUT
	exit 0
	fi
	# Deploy if relevant source or docs files were changed
	CHANGED=$(git diff --name-only HEAD~1 HEAD 2>/dev/null || echo "")
	echo "Changed files: $CHANGED"
	if echo "$CHANGED" | grep -qE '^(docs/|mkdocs\.yml|pytrendy/)'; then
	echo "Deploying: relevant files changed"
	echo "should_deploy=true" >> $GITHUB_OUTPUT
	exit 0
	fi
	echo "Skipping: no relevant changes detected"
	echo "should_deploy=false" >> $GITHUB_OUTPUT
	fetch-depth: 0
	- name: Determine if docs deployment is needed
	id: check
	run: |
	EVENT_PATH="${GITHUB_EVENT_PATH}"
	if [ -z "$EVENT_PATH" ] || [ ! -f "$EVENT_PATH" ]; then
	echo "Event payload not found; defaulting to deploy docs"
	echo "should_deploy=true" >> "$GITHUB_OUTPUT"
	exit 0
	fi
	# Aggregate all commit messages from the push event (subject + body)
	COMMIT_MESSAGES=$(jq -r '.commits[]?.message' "$EVENT_PATH")
	echo "Commit messages in push:"
	echo "$COMMIT_MESSAGES"
	# Skip if any commit explicitly flags docs to be skipped
	if echo "$COMMIT_MESSAGES" | grep -q '\[skip docs\]'; then
	echo "Skipping: [skip docs] flag found in at least one commit"
	echo "should_deploy=false" >> "$GITHUB_OUTPUT"
	exit 0
	fi
	# Always deploy for semantic commit types that affect code or content:
	# feat (minor/major), fix (patch), docs, refactor, perf
	if echo "$COMMIT_MESSAGES" | grep -qE '^(feat|fix|docs|refactor|perf)(\([^)]*\))?!?:'; then
	echo "Deploying: matched semantic commit type in at least one commit"
	echo "should_deploy=true" >> "$GITHUB_OUTPUT"
	exit 0
	fi
	# Breaking changes (major version bump) — e.g. feat!: or type(scope)!:
	if echo "$COMMIT_MESSAGES" | grep -qE '^[a-z]+(\([^)]*\))?!:'; then
	echo "Deploying: breaking change in commit subject"
	echo "should_deploy=true" >> "$GITHUB_OUTPUT"
	exit 0
	fi
	# Breaking change declared in any commit body
	if echo "$COMMIT_MESSAGES" | grep -q 'BREAKING CHANGE'; then
	echo "Deploying: BREAKING CHANGE found in commit body"
	echo "should_deploy=true" >> "$GITHUB_OUTPUT"
	exit 0
	fi
	# Determine the diff range for the entire push
	BEFORE_SHA=$(jq -r '.before' "$EVENT_PATH")
	HEAD_SHA="${GITHUB_SHA}"
	if [ -n "$BEFORE_SHA" ] && ! echo "$BEFORE_SHA" | grep -qE '^0+$'; then
	echo "Using diff range: $BEFORE_SHA..$HEAD_SHA"
	CHANGED=$(git diff --name-only "$BEFORE_SHA" "$HEAD_SHA" 2>/dev/null || echo "")
	else
	echo "No valid 'before' SHA in event; falling back to HEAD~1..HEAD"
	CHANGED=$(git diff --name-only HEAD~1 HEAD 2>/dev/null || echo "")
	fi
	echo "Changed files across push: $CHANGED"
	if echo "$CHANGED" | grep -qE '^(docs/|mkdocs\.yml|pytrendy/)'; then
	echo "Deploying: relevant files changed"
	echo "should_deploy=true" >> "$GITHUB_OUTPUT"
	exit 0
	fi
	echo "Skipping: no relevant changes detected"
	echo "should_deploy=false" >> "$GITHUB_OUTPUT"