From a693c34524d8da4fe3392fbe51333a37e4f018c8 Mon Sep 17 00:00:00 2001 From: Fabio Buso Date: Thu, 13 Jun 2024 14:37:03 +0200 Subject: [PATCH 1/2] [FSTORE-1426] add requirements.txt for documentation instead of using a profile in hsfs --- .github/workflows/mkdocs-release.yml | 4 ++-- .github/workflows/mkdocs-test.yml | 2 +- requirements-docs.txt | 11 +++++++++++ 3 files changed, 14 insertions(+), 3 deletions(-) create mode 100644 requirements-docs.txt diff --git a/.github/workflows/mkdocs-release.yml b/.github/workflows/mkdocs-release.yml index ce203a4fd..06a828f08 100644 --- 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 index ef6362deb..1927a25be 100644 --- 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 new file mode 100644 index 000000000..d1499a262 --- /dev/null +++ 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://git@github.com/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 From 2d67a8778800992aec555956d75315315b2f41f8 Mon Sep 17 00:00:00 2001 From: Fabio Buso Date: Thu, 13 Jun 2024 15:03:37 +0200 Subject: [PATCH 2/2] Update requirements and add linkchecker --- requirements-docs.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/requirements-docs.txt b/requirements-docs.txt index d1499a262..560779ddb 100644 --- a/requirements-docs.txt +++ b/requirements-docs.txt @@ -9,3 +9,4 @@ markdown==3.6 pymdown-extensions==10.7.1 mkdocs-macros-plugin==1.0.4 mkdocs-minify-plugin>=0.2.0 +linkchecker