[FSTORE-1426] add requirements.txt for documentation instead of using…

… a profile in hsfs
logicalclocks · Jun 13, 2024 · a693c34 · a693c34
1 parent 8d58f51
commit a693c34
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 3 deletions.
diff --git a/.github/workflows/mkdocs-release.yml b/.github/workflows/mkdocs-release.yml
@@ -2,7 +2,7 @@ name: mkdocs-release
 
 on:
   push:
-    branches: [branch-*]
+    branches: [branch-*\.*]
 
 jobs:
   publish-release:
@@ -21,7 +21,7 @@ jobs:
         run: sudo apt-get install -y libxml2-dev libxslt-dev
 
       - name: install deps
-        run: pip3 install 'git+https://github.com/logicalclocks/feature-store-api@master#egg=hsfs[docs]&subdirectory=python'
+        run: pip3 install -r requirements-docs.txt
 
       - name: setup git
         run: |

diff --git a/.github/workflows/mkdocs-test.yml b/.github/workflows/mkdocs-test.yml
@@ -20,7 +20,7 @@ jobs:
         run: sudo apt-get install -y libxml2-dev libxslt-dev
 
       - name: install deps
-        run: pip3 install 'git+https://github.com/logicalclocks/feature-store-api@master#egg=hsfs[docs]&subdirectory=python' linkchecker
+        run: pip3 install -r requirements-docs.txt
 
       - name: setup git
         run: |

diff --git a/requirements-docs.txt b/requirements-docs.txt
@@ -0,0 +1,11 @@
+mkdocs==1.5.3
+mkdocs-material==9.5.17
+mike==2.0.0
+sphinx==7.2.6
+keras_autodoc @ git+https://[email protected]/logicalclocks/keras-autodoc
+markdown-include==0.8.1
+mkdocs-jupyter==0.24.3
+markdown==3.6
+pymdown-extensions==10.7.1
+mkdocs-macros-plugin==1.0.4
+mkdocs-minify-plugin>=0.2.0