Merge pull request #542 from jacebrowning/deploy-site

Deploy static site
jacebrowning · Nov 3, 2020 · 9ef7d6a · 9ef7d6a
2 parents aeaebdb + 3773426
commit 9ef7d6a
Show file tree

Hide file tree

Showing 7 changed files with 200 additions and 16 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -11,14 +11,14 @@ jobs:
       - checkout
 
       - run:
-          name: Checking System Dependencies
+          name: Checking system dependencies
           command: make doctor
 
       - type: cache-restore
         key: poetry-{{ checksum "poetry.lock" }}
 
       - run:
-          name: Installing Project Dependencies
+          name: Installing project dependencies
           command: make install
 
       - type: cache-save
@@ -27,15 +27,19 @@ jobs:
           - .venv
 
       - run:
-          name: Checking Code
+          name: Checking code
           command: make check
 
       - run:
-          name: Running Tests
+          name: Running tests
           command: make test && sudo pip install coveralls && coveralls
 
       - store_test_results:
           path: results
 
       - store_artifacts:
           path: htmlcov
+
+      - run:
+          name: Building site
+          command: make site
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -19,6 +19,7 @@
   "cSpell.words": [
     "CIRCLECI",
     "Kombucha",
+    "Memegen",
     "aiofiles",
     "aiohttp",
     "jsonify",

diff --git a/Makefile b/Makefile
@@ -97,6 +97,20 @@ watch: install
 	@ sleep 2 && touch */__init__.py &
 	@ poetry run watchmedo shell-command --recursive --pattern="*.py;*.yml" --command="clear && make test check format SKIP_SLOW=true && echo && echo ✅ && echo" --wait --drop
 
+.PHONY: site
+site: install
+ifdef CI
+	poetry run mkdocs build --strict
+ifeq ($(CIRCLE_BRANCH),main)
+	@ echo
+	git config --global user.name CircleCI
+	echo site.memegen.link > site/CNAME
+	poetry run mkdocs gh-deploy --dirty
+endif
+else
+	poetry run mkdocs serve
+endif
+
 ###############################################################################
 # Delivery Tasks
 

diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1 @@
+../README.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,2 @@
+site_name: Memegen API
+remote_branch: site
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -60,6 +60,9 @@ locust = "^1.2.3"
 # Coverage
 coveragespace = "^3.1.1"
 
+# Documentation
+mkdocs = "^1.0"
+
 # Utilities
 ipdb = "*"
 rope = "^0.14.0"