diff --git a/.github/workflows/deploy-docs.yaml b/.github/workflows/deploy-docs.yaml index d246c38..bb9bd8c 100644 --- a/.github/workflows/deploy-docs.yaml +++ b/.github/workflows/deploy-docs.yaml @@ -32,5 +32,5 @@ jobs: - name: Install dependencies and deploy run: | - uv install mkdocs-material --system + uv install mkdocs-material textual --system mkdocs gh-deploy --force diff --git a/.github/workflows/pull-request.yaml b/.github/workflows/pull-request.yaml index cad0dbf..740144b 100644 --- a/.github/workflows/pull-request.yaml +++ b/.github/workflows/pull-request.yaml @@ -61,5 +61,5 @@ jobs: run: curl -LsSf https://astral.sh/uv/install.sh | sh - name: Install dependencies and check docs can build run: | - uv pip install mkdocs-material --system + uv pip install mkdocs-material textual --system mkdocs build -v -s diff --git a/.gitignore b/.gitignore index 86d443e..1966568 100644 --- a/.gitignore +++ b/.gitignore @@ -160,3 +160,6 @@ cython_debug/ # and can be added to the global gitignore or merged into this file. For a more nuclear # option (not recommended) you can uncomment the following to ignore the entire idea folder. #.idea/ + +# Cache of screenshots used in the docs +.screenshot_cache \ No newline at end of file diff --git a/Makefile b/Makefile index fc59de6..c5de7c8 100644 --- a/Makefile +++ b/Makefile @@ -5,7 +5,9 @@ clean-folders: .pytest_cache */.pytest_cache */**/.pytest_cache \ .ruff_cache */.ruff_cache */**/.ruff_cache \ .mypy_cache */.mypy_cache */**/.mypy_cache \ + .screenshot_cache \ site build dist htmlcov .coverage .tox + lint: ruff version diff --git a/docs/index.md b/docs/index.md index b45c393..53ffda7 100644 --- a/docs/index.md +++ b/docs/index.md @@ -6,7 +6,7 @@ Scikit-learn smithy is a tool that helps you to forge scikit-learn compatible es How can you use it? -- [x] Directly from the browser via our [web UI](https://sklearn-smithy.streamlit.app/){:target="_blank"} ([more info](user-guide.md/#web-ui)). +- [x] Directly from the browser via our [web UI](https://sklearn-smithy.streamlit.app/){:target="_blank"} ([more info](user-guide.md/#web-ui)) - [x] As a CLI (command line interface) in your terminal via the `smith forge` command ([more info](user-guide.md/#cli)) - [x] As a TUI (terminal user interface) in your terminal via the `smith-tui` command ([more info](user-guide.md/#tui)) diff --git a/docs/user-guide.md b/docs/user-guide.md index f54ac36..c3b4b53 100644 --- a/docs/user-guide.md +++ b/docs/user-guide.md @@ -25,7 +25,7 @@ TL;DR: - [x] Available via the `smith forge` command. - [x] It requires [installation](installation.md): `python -m pip install sklearn-smithy` -- [x] Powered by [typer](https://typer.tiangolo.com/). +- [x] Powered by [typer](https://typer.tiangolo.com/){:target="_blank"}. Once the library is installed, the `smith` CLI (Command Line Interface) will be available and that is the primary way to interact with the `smithy` package. @@ -64,13 +64,12 @@ Now the estimator template to be filled will be available at the specified path