diff --git a/.github/workflows/mkdocs-main.yml b/.github/workflows/mkdocs-main.yml index de5257cc8..9294fef53 100644 --- a/.github/workflows/mkdocs-main.yml +++ b/.github/workflows/mkdocs-main.yml @@ -21,10 +21,10 @@ jobs: - name: install deps working-directory: ./python - run: cp ../README.md . && pip3 install -r ../requirements-docs.txt && pip3 install -e .[dev] + run: cp ../README.md . && pip3 install -e .[dev] - name: generate autodoc - run: python3 auto_doc.py + run: python3 ./python/auto_doc.py - name: Cache local Maven repository uses: actions/cache@v2 diff --git a/.github/workflows/mkdocs-release.yml b/.github/workflows/mkdocs-release.yml index d50bce485..80a325760 100644 --- a/.github/workflows/mkdocs-release.yml +++ b/.github/workflows/mkdocs-release.yml @@ -26,10 +26,10 @@ jobs: - name: install deps working-directory: ./python - run: cp ../README.md . && pip3 install -r ../requirements-docs.txt && pip3 install -e .[dev] + run: cp ../README.md . && pip3 install -e .[dev] - name: generate autodoc - run: python3 auto_doc.py + run: python3 ./python/auto_doc.py - name: Cache local Maven repository uses: actions/cache@v2 diff --git a/auto_doc.py b/python/auto_doc.py similarity index 99% rename from auto_doc.py rename to python/auto_doc.py index 91d3f358d..080a29094 100644 --- a/auto_doc.py +++ b/python/auto_doc.py @@ -682,7 +682,7 @@ }, } -hw_dir = pathlib.Path(__file__).resolve().parents[0] +hw_dir = pathlib.Path(__file__).resolve().parents[1] if "GITHUB_SHA" in os.environ: commit_sha = os.environ["GITHUB_SHA"] project_url = ( diff --git a/python/pyproject.toml b/python/pyproject.toml index 9452f5061..bfe782997 100644 --- a/python/pyproject.toml +++ b/python/pyproject.toml @@ -86,7 +86,20 @@ dev-pandas1 = [ "pandas<=1.5.3", "sqlalchemy<=1.4.48", ] -dev = ["hopsworks[dev-no-opt,great-expectations]"] +dev-docs = [ + "mkdocs==1.5.3", + "mkdocs-material==9.5.17", + "mike==2.0.0", + "sphinx==7.3.7", + "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", +] +dev = ["hopsworks[dev-no-opt,great-expectations,dev-docs]"] [build-system] requires = ["setuptools", "wheel"] diff --git a/requirements-docs.txt b/requirements-docs.txt deleted file mode 100644 index 8bc8d6230..000000000 --- a/requirements-docs.txt +++ /dev/null @@ -1,11 +0,0 @@ -mkdocs==1.5.3 -mkdocs-material==9.5.17 -mike==2.0.0 -sphinx==7.3.7 -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