Skip to content

Commit

Permalink
[FSTORE-1426] add requirements.txt for documentation instead of using…
Browse files Browse the repository at this point in the history
… a profile in hsfs (#209)
  • Loading branch information
SirOibaf authored Jun 13, 2024
1 parent bdaff4c commit eea1037
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 15 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/mkdocs-main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ jobs:

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

- name: generate autodoc
run: python3 auto_doc.py
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/mkdocs-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: mkdocs-release

on:
push:
branches: [branch-*]
branches: [branch-*\.*]

jobs:
publish-release:
Expand All @@ -26,7 +26,7 @@ jobs:

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

- name: generate autodoc
run: python3 auto_doc.py
Expand Down
12 changes: 0 additions & 12 deletions python/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -35,18 +35,6 @@ dependencies = [

[project.optional-dependencies]
dev = [ "ruff", "pytest"]
docs = [
"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",
"markdown==3.6",
"pymdown-extensions==10.7.1",
"mkdocs-macros-plugin==1.0.4",
"mkdocs-minify-plugin>=0.2.0",
]

[build-system]
requires = ["setuptools", "wheel"]
Expand Down
11 changes: 11 additions & 0 deletions requirements-docs.txt
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit eea1037

Please sign in to comment.