docs: remove conflicting README.md and add mkdocs dependency #3

	name: Deploy Documentation

	on:
	push:
	branches:
	- main
	paths:
	- 'docs/**'
	- '.github/workflows/docs.yml'
	workflow_dispatch:

	permissions:
	contents: read
	pages: write
	id-token: write

	concurrency:
	group: pages
	cancel-in-progress: false

	jobs:
	build:
	name: Build Documentation
	runs-on: ubuntu-latest

	steps:
	- name: Checkout code
	uses: actions/checkout@v4

	- name: Set up Python
	uses: actions/setup-python@v5
	with:
	python-version: '3.12'
	cache: 'pip'
	cache-dependency-path: docs/requirements.txt

	- name: Install dependencies
	run: \|
	pip install -r docs/requirements.txt

	- name: Build documentation
	run: \|
	cd docs
	mkdocs build --strict

	- name: Upload artifact
	uses: actions/upload-pages-artifact@v3
	with:
	path: docs/site

	deploy:
	name: Deploy to GitHub Pages
	needs: build
	runs-on: ubuntu-latest

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

	steps:
	- name: Deploy to GitHub Pages
	id: deployment
	uses: actions/deploy-pages@v4

	- name: Generate deployment summary
	run: \|
	echo "## Documentation Deployed 📚" >> $GITHUB_STEP_SUMMARY
	echo "" >> $GITHUB_STEP_SUMMARY
	echo "URL: ${{ steps.deployment.outputs.page_url }}" >> $GITHUB_STEP_SUMMARY
	echo "" >> $GITHUB_STEP_SUMMARY
	echo "Documentation has been successfully deployed to GitHub Pages!" >> $GITHUB_STEP_SUMMARY

Navigation Menu