Skip to content

Commit 0d0388c

Browse files
committed
[FSTORE-1426] add requirements.txt for documentation instead of using a profile in hsfs
1 parent bdaff4c commit 0d0388c

File tree

4 files changed

+14
-15
lines changed

4 files changed

+14
-15
lines changed

.github/workflows/mkdocs-main.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ jobs:
2121

2222
- name: install deps
2323
working-directory: ./python
24-
run: cp ../README.md . && pip3 install 'hsfs[python] @ git+https://github.com/logicalclocks/feature-store-api@master#subdirectory=python' && pip3 install -e .[dev,docs]
24+
run: cp ../README.md . && pip3 install -r ../requirements-docs.txt && pip3 install -e .[dev]
2525

2626
- name: generate autodoc
2727
run: python3 auto_doc.py

.github/workflows/mkdocs-release.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name: mkdocs-release
22

33
on:
44
push:
5-
branches: [branch-*]
5+
branches: [branch-*\.*]
66

77
jobs:
88
publish-release:
@@ -26,7 +26,7 @@ jobs:
2626

2727
- name: install deps
2828
working-directory: ./python
29-
run: cp ../README.md . && pip3 install -e .[dev,docs]
29+
run: cp ../README.md . && pip3 install -r ../requirements-docs.txt && pip3 install -e .[dev]
3030

3131
- name: generate autodoc
3232
run: python3 auto_doc.py

python/pyproject.toml

-12
Original file line numberDiff line numberDiff line change
@@ -35,18 +35,6 @@ dependencies = [
3535

3636
[project.optional-dependencies]
3737
dev = [ "ruff", "pytest"]
38-
docs = [
39-
"mkdocs==1.5.3",
40-
"mkdocs-material==9.5.17",
41-
"mike==2.0.0",
42-
"sphinx==7.2.6",
43-
"keras_autodoc @ git+https://git@github.com/logicalclocks/keras-autodoc",
44-
"markdown-include==0.8.1",
45-
"markdown==3.6",
46-
"pymdown-extensions==10.7.1",
47-
"mkdocs-macros-plugin==1.0.4",
48-
"mkdocs-minify-plugin>=0.2.0",
49-
]
5038

5139
[build-system]
5240
requires = ["setuptools", "wheel"]

requirements-docs.txt

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
mkdocs==1.5.3
2+
mkdocs-material==9.5.17
3+
mike==2.0.0
4+
sphinx==7.2.6
5+
keras_autodoc @ git+https://git@github.com/logicalclocks/keras-autodoc
6+
markdown-include==0.8.1
7+
mkdocs-jupyter==0.24.3
8+
markdown==3.6
9+
pymdown-extensions==10.7.1
10+
mkdocs-macros-plugin==1.0.4
11+
mkdocs-minify-plugin>=0.2.0

0 commit comments

Comments
 (0)