diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index c8c3c66ea..dba22ca26 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -70,6 +70,12 @@ repos: types: [python, text] files: ^(examples/|docs/src/|packages/notte-sdk/src/).*\.(py|mdx)$ pass_filenames: false + - id: docs-sdk-generate + name: Regenerate SDK reference docs + entry: bash -c "make docs-sdk" + language: system + files: ^(packages/notte-sdk/src/|docs/sphinx/conf\.py) + pass_filenames: false - id: no-loguru-logger-import name: Check for loguru logger imports entry: 'from loguru import logger' diff --git a/docs/src/sdk-reference/manual/session.mdx b/docs/src/sdk-reference/manual/session.mdx index 805a38236..511d8a34c 100644 --- a/docs/src/sdk-reference/manual/session.mdx +++ b/docs/src/sdk-reference/manual/session.mdx @@ -47,7 +47,7 @@ You can use the default parameters to create your session, or customize them: File Storage to attach to the session - + diff --git a/docs/src/sdk-reference/misc/captchasolveaction.mdx b/docs/src/sdk-reference/misc/captchasolveaction.mdx index 465b750ed..7a5d06669 100644 --- a/docs/src/sdk-reference/misc/captchasolveaction.mdx +++ b/docs/src/sdk-reference/misc/captchasolveaction.mdx @@ -22,7 +22,7 @@ session.execute(type="captcha_solve") # Auto-detect captcha type - + diff --git a/docs/src/sdk-reference/misc/formfillaction.mdx b/docs/src/sdk-reference/misc/formfillaction.mdx index 5fc9b808f..cace71378 100644 --- a/docs/src/sdk-reference/misc/formfillaction.mdx +++ b/docs/src/sdk-reference/misc/formfillaction.mdx @@ -21,7 +21,7 @@ session.execute(type="form_fill", value={"email": "user@example.com", "first_nam - + diff --git a/docs/src/sdk-reference/misc/rootmodel.mdx b/docs/src/sdk-reference/misc/rootmodel.mdx new file mode 100644 index 000000000..f003de2c5 --- /dev/null +++ b/docs/src/sdk-reference/misc/rootmodel.mdx @@ -0,0 +1,16 @@ +--- +title: "RootModel" +description: "" +--- + + + +## Fields + + + + + +## Module + +`pydantic.root_model` diff --git a/docs/src/sdk-reference/misc/structureddata.mdx b/docs/src/sdk-reference/misc/structureddata.mdx index 5a261c32e..e189c3069 100644 --- a/docs/src/sdk-reference/misc/structureddata.mdx +++ b/docs/src/sdk-reference/misc/structureddata.mdx @@ -15,7 +15,7 @@ description: "" Error message if the data was not extracted successfully - + Structured data extracted from the page in JSON format diff --git a/docs/src/sdk-reference/misc/websocketservice.mdx b/docs/src/sdk-reference/misc/websocketservice.mdx index 79ae6307d..5eb6d8092 100644 --- a/docs/src/sdk-reference/misc/websocketservice.mdx +++ b/docs/src/sdk-reference/misc/websocketservice.mdx @@ -10,7 +10,7 @@ description: "WebSocket client for receiving session recording data in binary fo - + diff --git a/docs/src/sdk-reference/nottefunction/run.mdx b/docs/src/sdk-reference/nottefunction/run.mdx index d12ef0264..3e41eed0e 100644 --- a/docs/src/sdk-reference/nottefunction/run.mdx +++ b/docs/src/sdk-reference/nottefunction/run.mdx @@ -41,7 +41,7 @@ function.run(variable1="value1", variable2="value2") - + diff --git a/docs/src/sdk-reference/nottevault/patch_structured_completion.mdx b/docs/src/sdk-reference/nottevault/patch_structured_completion.mdx index 24912b175..c576c5055 100644 --- a/docs/src/sdk-reference/nottevault/patch_structured_completion.mdx +++ b/docs/src/sdk-reference/nottevault/patch_structured_completion.mdx @@ -11,5 +11,5 @@ description: "No description available" - + diff --git a/docs/src/sdk-reference/remotesession/__init__.mdx b/docs/src/sdk-reference/remotesession/__init__.mdx index 36b787e04..8cf46ac56 100644 --- a/docs/src/sdk-reference/remotesession/__init__.mdx +++ b/docs/src/sdk-reference/remotesession/__init__.mdx @@ -19,7 +19,7 @@ RemoteSession instance configured with the specified parameters. File Storage to attach to the session - + diff --git a/makefile b/makefile index cd804ec72..50c2024e2 100644 --- a/makefile +++ b/makefile @@ -107,7 +107,6 @@ profile-imports: .PHONY: docs-sdk docs-sdk: - @uv pip install -e ../sphinx_mintlify cd docs && uv run sphinx-build -b mdx sphinx _build rm -rf docs/src/sdk-reference/baseaction diff --git a/pyproject.toml b/pyproject.toml index e84989391..c5791f3f2 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -70,6 +70,7 @@ dev = [ "pytest-timeout>=2.4.0", "pytest-xdist[psutil]>=3.8.0", "sphinx>=8.2.3", + "sphinx-mintlify>=0.1.0", "twine>=6.1.0", ] lint = [ diff --git a/uv.lock b/uv.lock index bbbdaa557..dd2b1a47b 100644 --- a/uv.lock +++ b/uv.lock @@ -2861,6 +2861,7 @@ dev = [ { name = "pytest-timeout" }, { name = "pytest-xdist", extra = ["psutil"] }, { name = "sphinx" }, + { name = "sphinx-mintlify" }, { name = "twine" }, ] lint = [ @@ -2904,6 +2905,7 @@ dev = [ { name = "pytest-timeout", specifier = ">=2.4.0" }, { name = "pytest-xdist", extras = ["psutil"], specifier = ">=3.8.0" }, { name = "sphinx", specifier = ">=8.2.3" }, + { name = "sphinx-mintlify", specifier = ">=0.1.0" }, { name = "twine", specifier = ">=6.1.0" }, ] lint = [{ name = "ruff", specifier = ">=0.9.7" }] @@ -7800,6 +7802,20 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/31/53/136e9eca6e0b9dc0e1962e2c908fbea2e5ac000c2a2fbd9a35797958c48b/sphinx-8.2.3-py3-none-any.whl", hash = "sha256:4405915165f13521d875a8c29c8970800a0141c14cc5416a38feca4ea5d9b9c3", size = 3589741, upload-time = "2025-03-02T22:31:56.836Z" }, ] +[[package]] +name = "sphinx-mintlify" +version = "0.1.1" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "docutils" }, + { name = "sphinx" }, + { name = "typing-extensions" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/e8/a1/6eb6cfbd41e520f746c762bdc0373bf6b4853b4db4a2dd635c54daf32ae5/sphinx_mintlify-0.1.1.tar.gz", hash = "sha256:e04fd6bba69c198c2965992664f2808830070839afdfa539d885fbe73d1c20e0", size = 20295, upload-time = "2026-04-15T23:02:37.958Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/9b/b4/30f62774e9f9bd2c63b97c5834173f612970a8a56389f605f3d6c15b85fb/sphinx_mintlify-0.1.1-py3-none-any.whl", hash = "sha256:618bc2ee32deb350169d6310d9b4dca6533de3dec438943368de4f9762a958cb", size = 21100, upload-time = "2026-04-15T23:02:36.781Z" }, +] + [[package]] name = "sphinxcontrib-applehelp" version = "2.0.0"