Standardize docs Makefile and add documentation URL

This commit is contained in:
Chris Proctor
2026-06-22 22:18:59 -04:00
parent 5f74dbba8d
commit 426e59a54e
3 changed files with 18 additions and 9 deletions

View File

@@ -1,8 +1,14 @@
.PHONY: docs deploy
S3_BUCKET = s3://docs.makingwithcode.org/retro-gamer/
CF_DISTRIBUTION = EPA6NHZ2LEH1A
docs:
uv run --group documentation sphinx-build -b html docs docs/_build/html
.PHONY: build deploy clean
deploy: docs
aws s3 sync docs/_build/html s3://docs.makingwithcode.org/retro-gamer/
aws cloudfront create-invalidation --distribution-id EPA6NHZ2LEH1A --paths "/retro-gamer/*"
build:
uv run --group documentation $(MAKE) -C docs html
deploy: build
aws s3 sync docs/_build/html $(S3_BUCKET)
aws cloudfront create-invalidation --distribution-id $(CF_DISTRIBUTION) --paths "/retro-gamer/*"
clean:
$(MAKE) -C docs clean

View File

@@ -1,6 +1,6 @@
[project]
name = "retro-gamer"
version = "0.1.0"
version = "0.1.1"
description = "A toolkit for learning reinforcement learning by training agents to play retro games"
readme = "README.md"
requires-python = ">=3.11"
@@ -16,6 +16,9 @@ dependencies = [
"seaborn>=0.13",
]
[project.urls]
documentation = "https://docs.makingwithcode.org/retro-gamer"
[project.scripts]
retro-gamer = "retro_gamer.cli:cli"

4
uv.lock generated
View File

@@ -1154,7 +1154,7 @@ wheels = [
[[package]]
name = "retro-gamer"
version = "0.1.0"
version = "0.1.1"
source = { editable = "." }
dependencies = [
{ name = "click" },
@@ -1196,7 +1196,7 @@ documentation = [
[[package]]
name = "retro-games"
version = "2.4.0"
version = "2.4.1"
source = { editable = "../retro" }
dependencies = [
{ name = "blessed" },