removing docs gh-actions; adding note on how to build in index/readme

BrentLab · May 1, 2024 · 1b6e5ed · 1b6e5ed
1 parent cc8bbc3
commit 1b6e5ed
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 26 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
diff --git 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
@@ -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.
+        ...       # Other markdown pages, images and other files.
+
+To update the gh-pages documentation, use `poetry run mkdocs gh-deply`
+