From 41ce3dca3f9f30f16f33caf1be58bcc80c141528 Mon Sep 17 00:00:00 2001 From: Fabio Buso Date: Thu, 13 Jun 2024 14:06:09 +0200 Subject: [PATCH] [FSTORE-1426] add requirements.txt for documentation instead of using a profile in hsfs (#1351) --- .github/workflows/mkdocs-master.yml | 2 +- .github/workflows/mkdocs-release.yml | 2 +- python/pyproject.toml | 13 ------------- requirements-docs.txt | 11 +++++++++++ 4 files changed, 13 insertions(+), 15 deletions(-) create mode 100644 requirements-docs.txt diff --git a/.github/workflows/mkdocs-master.yml b/.github/workflows/mkdocs-master.yml index 1fa2702289..1c904ad28c 100644 --- a/.github/workflows/mkdocs-master.yml +++ b/.github/workflows/mkdocs-master.yml @@ -21,7 +21,7 @@ jobs: - name: install deps working-directory: ./python - run: cp ../README.md . && pip3 install -e .[python,dev,docs] + run: cp ../README.md . && pip3 install -r ../requirements-docs.txt && pip3 install -e .[python,dev] - name: generate autodoc run: python3 auto_doc.py diff --git a/.github/workflows/mkdocs-release.yml b/.github/workflows/mkdocs-release.yml index 03cd0b5065..66ca638aea 100644 --- a/.github/workflows/mkdocs-release.yml +++ b/.github/workflows/mkdocs-release.yml @@ -26,7 +26,7 @@ jobs: - name: install deps working-directory: ./python - run: cp ../README.md . && pip3 install -e .[python,dev,docs] + run: cp ../README.md . && pip3 install -r ../requirements-docs.txt && pip3 install -e .[python,dev] - name: generate autodoc run: python3 auto_doc.py diff --git a/python/pyproject.toml b/python/pyproject.toml index a4e5c9b5f5..0ba86dfc4a 100644 --- a/python/pyproject.toml +++ b/python/pyproject.toml @@ -68,19 +68,6 @@ dev-pandas1 = [ "pandas<=1.5.3", "sqlalchemy<=1.4.48", ] -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", - "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", -] hive = [ "pyhopshive[thrift]", "pyarrow>=10.0", diff --git a/requirements-docs.txt b/requirements-docs.txt new file mode 100644 index 0000000000..d1499a2625 --- /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