From c06e704cbee388e21390e42180a3130e6f8ec179 Mon Sep 17 00:00:00 2001
From: Chase Mateusiak <chase.mateusiak@gmail.com>
Date: Tue, 30 Apr 2024 21:09:32 -0500
Subject: [PATCH] removing docs gh-actions; adding note on how to build in
 index/readme (#80)

---
 .github/workflows/docs.yml | 25 -------------------------
 README.md                  |  2 ++
 docs/index.md              |  5 ++++-
 3 files changed, 6 insertions(+), 26 deletions(-)
 delete mode 100644 .github/workflows/docs.yml

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
deleted file mode 100644
index b61a008..0000000
--- a/.github/workflows/docs.yml
+++ /dev/null
@@ -1,25 +0,0 @@
-name: gh-pages
-on:
-  push:
-    branches:
-      - main
-
-jobs:
-  build:
-    name: Deploy docs
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout main
-        uses: actions/checkout@v4
-
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: "3.x"
-
-      - name: Install requirements
-        run: |
-          pip install -U pip
-          pip install poetry
-          poetry install
-          poetry run mkdocs gh-deploy
diff --git a/README.md b/README.md
index 5324e89..f261ef7 100644
--- a/README.md
+++ b/README.md
@@ -95,3 +95,5 @@ The documentation is build with mkdocs:
 * docs/
    * index.md  # The documentation homepage.
    * ...       # Other markdown pages, images and other files.
+
+To update the gh-pages documentation, use `poetry run mkdocs gh-deply`
diff --git a/docs/index.md b/docs/index.md
index 833fa27..a639a79 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -99,4 +99,7 @@ to execute the following:
     mkdocs.yml    # The configuration file.
     docs/
         index.md  # The documentation homepage.
-        ...       # Other markdown pages, images and other files.
\ No newline at end of file
+        ...       # Other markdown pages, images and other files.
+
+To update the gh-pages documentation, use `poetry run mkdocs gh-deply`
+