{"payload":{"allShortcutsEnabled":false,"path":"docs","repo":{"id":871552150,"defaultBranch":"main","name":"datafusion-python","ownerLogin":"ion-elgreco","currentUserCanPush":false,"isFork":true,"isEmpty":false,"createdAt":"2024-10-12T09:25:35.000Z","ownerAvatar":"https://avatars.githubusercontent.com/u/15728914?v=4","public":true,"private":false,"isOrgOwned":false},"currentUser":null,"refInfo":{"name":"main","listCacheKey":"v0:1735385215.0","canEdit":false,"refType":"branch","currentOid":"79c22d6d6c0809e7e93a0a23249baa516dbd8d6f"},"tree":{"items":[{"name":"mdbook","path":"docs/mdbook","contentType":"directory"},{"name":"source","path":"docs/source","contentType":"directory"},{"name":".gitignore","path":"docs/.gitignore","contentType":"file"},{"name":"Makefile","path":"docs/Makefile","contentType":"file"},{"name":"README.md","path":"docs/README.md","contentType":"file"},{"name":"build.sh","path":"docs/build.sh","contentType":"file"},{"name":"make.bat","path":"docs/make.bat","contentType":"file"},{"name":"requirements.txt","path":"docs/requirements.txt","contentType":"file"}],"templateDirectorySuggestionUrl":null,"readme":{"displayName":"README.md","richText":"\u003carticle class=\"markdown-body entry-content container-lg\" itemprop=\"text\"\u003e\n\u003cdiv class=\"markdown-heading\" dir=\"auto\"\u003e\u003ch1 tabindex=\"-1\" class=\"heading-element\" dir=\"auto\"\u003eDataFusion Documentation\u003c/h1\u003e\u003ca id=\"user-content-datafusion-documentation\" class=\"anchor\" aria-label=\"Permalink: DataFusion Documentation\" href=\"#datafusion-documentation\"\u003e\u003csvg class=\"octicon octicon-link\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" height=\"16\" aria-hidden=\"true\"\u003e\u003cpath d=\"m7.775 3.275 1.25-1.25a3.5 3.5 0 1 1 4.95 4.95l-2.5 2.5a3.5 3.5 0 0 1-4.95 0 .751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018 1.998 1.998 0 0 0 2.83 0l2.5-2.5a2.002 2.002 0 0 0-2.83-2.83l-1.25 1.25a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042Zm-4.69 9.64a1.998 1.998 0 0 0 2.83 0l1.25-1.25a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042l-1.25 1.25a3.5 3.5 0 1 1-4.95-4.95l2.5-2.5a3.5 3.5 0 0 1 4.95 0 .751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018 1.998 1.998 0 0 0-2.83 0l-2.5 2.5a1.998 1.998 0 0 0 0 2.83Z\"\u003e\u003c/path\u003e\u003c/svg\u003e\u003c/a\u003e\u003c/div\u003e\n\u003cp dir=\"auto\"\u003eThis folder contains the source content of the \u003ca href=\"/ion-elgreco/datafusion-python/blob/main/docs/source/api\"\u003ePython API\u003c/a\u003e.\nThis is published to \u003ca href=\"https://datafusion.apache.org/python\" rel=\"nofollow\"\u003ehttps://datafusion.apache.org/python\u003c/a\u003e by a GitHub action\nwhen changes are merged to the main branch.\u003c/p\u003e\n\u003cdiv class=\"markdown-heading\" dir=\"auto\"\u003e\u003ch2 tabindex=\"-1\" class=\"heading-element\" dir=\"auto\"\u003eDependencies\u003c/h2\u003e\u003ca id=\"user-content-dependencies\" class=\"anchor\" aria-label=\"Permalink: Dependencies\" href=\"#dependencies\"\u003e\u003csvg class=\"octicon octicon-link\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" height=\"16\" aria-hidden=\"true\"\u003e\u003cpath d=\"m7.775 3.275 1.25-1.25a3.5 3.5 0 1 1 4.95 4.95l-2.5 2.5a3.5 3.5 0 0 1-4.95 0 .751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018 1.998 1.998 0 0 0 2.83 0l2.5-2.5a2.002 2.002 0 0 0-2.83-2.83l-1.25 1.25a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042Zm-4.69 9.64a1.998 1.998 0 0 0 2.83 0l1.25-1.25a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042l-1.25 1.25a3.5 3.5 0 1 1-4.95-4.95l2.5-2.5a3.5 3.5 0 0 1 4.95 0 .751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018 1.998 1.998 0 0 0-2.83 0l-2.5 2.5a1.998 1.998 0 0 0 0 2.83Z\"\u003e\u003c/path\u003e\u003c/svg\u003e\u003c/a\u003e\u003c/div\u003e\n\u003cp dir=\"auto\"\u003eIt's recommended to install build dependencies and build the documentation\ninside a Python \u003ccode\u003evenv\u003c/code\u003e.\u003c/p\u003e\n\u003cp dir=\"auto\"\u003eTo prepare building the documentation run the following on the root level of the project:\u003c/p\u003e\n\u003col dir=\"auto\"\u003e\n\u003cli\u003eSet up virtual environment if it was not already created\n\u003cdiv class=\"highlight highlight-source-shell notranslate position-relative overflow-auto\" dir=\"auto\" data-snippet-clipboard-copy-content=\"python3 -m venv venv\"\u003e\u003cpre\u003epython3 -m venv venv\u003c/pre\u003e\u003c/div\u003e\n\u003c/li\u003e\n\u003cli\u003eActivate virtual environment\n\u003cdiv class=\"highlight highlight-source-shell notranslate position-relative overflow-auto\" dir=\"auto\" data-snippet-clipboard-copy-content=\"source venv/bin/activate\"\u003e\u003cpre\u003e\u003cspan class=\"pl-c1\"\u003esource\u003c/span\u003e venv/bin/activate\u003c/pre\u003e\u003c/div\u003e\n\u003c/li\u003e\n\u003cli\u003eInstall Datafusion's Python dependencies\n\u003cdiv class=\"highlight highlight-source-shell notranslate position-relative overflow-auto\" dir=\"auto\" data-snippet-clipboard-copy-content=\"pip install -r requirements-310.txt\"\u003e\u003cpre\u003epip install -r requirements-310.txt\u003c/pre\u003e\u003c/div\u003e\n\u003c/li\u003e\n\u003cli\u003eInstall documentation dependencies\n\u003cdiv class=\"highlight highlight-source-shell notranslate position-relative overflow-auto\" dir=\"auto\" data-snippet-clipboard-copy-content=\"pip install -r docs/requirements.txt\"\u003e\u003cpre\u003epip install -r docs/requirements.txt\u003c/pre\u003e\u003c/div\u003e\n\u003c/li\u003e\n\u003c/ol\u003e\n\u003cdiv class=\"markdown-heading\" dir=\"auto\"\u003e\u003ch2 tabindex=\"-1\" class=\"heading-element\" dir=\"auto\"\u003eBuild \u0026amp; Preview\u003c/h2\u003e\u003ca id=\"user-content-build--preview\" class=\"anchor\" aria-label=\"Permalink: Build \u0026amp; Preview\" href=\"#build--preview\"\u003e\u003csvg class=\"octicon octicon-link\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" height=\"16\" aria-hidden=\"true\"\u003e\u003cpath d=\"m7.775 3.275 1.25-1.25a3.5 3.5 0 1 1 4.95 4.95l-2.5 2.5a3.5 3.5 0 0 1-4.95 0 .751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018 1.998 1.998 0 0 0 2.83 0l2.5-2.5a2.002 2.002 0 0 0-2.83-2.83l-1.25 1.25a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042Zm-4.69 9.64a1.998 1.998 0 0 0 2.83 0l1.25-1.25a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042l-1.25 1.25a3.5 3.5 0 1 1-4.95-4.95l2.5-2.5a3.5 3.5 0 0 1 4.95 0 .751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018 1.998 1.998 0 0 0-2.83 0l-2.5 2.5a1.998 1.998 0 0 0 0 2.83Z\"\u003e\u003c/path\u003e\u003c/svg\u003e\u003c/a\u003e\u003c/div\u003e\n\u003cp dir=\"auto\"\u003eRun the provided script to build the HTML pages.\u003c/p\u003e\n\u003cdiv class=\"highlight highlight-source-shell notranslate position-relative overflow-auto\" dir=\"auto\" data-snippet-clipboard-copy-content=\"cd docs\n./build.sh\"\u003e\u003cpre\u003e\u003cspan class=\"pl-c1\"\u003ecd\u003c/span\u003e docs\n./build.sh\u003c/pre\u003e\u003c/div\u003e\n\u003cp dir=\"auto\"\u003eThe HTML will be generated into a \u003ccode\u003ebuild\u003c/code\u003e directory.\u003c/p\u003e\n\u003cp dir=\"auto\"\u003ePreview the site on Linux by running this command.\u003c/p\u003e\n\u003cdiv class=\"highlight highlight-source-shell notranslate position-relative overflow-auto\" dir=\"auto\" data-snippet-clipboard-copy-content=\"firefox build/html/index.html\"\u003e\u003cpre\u003efirefox build/html/index.html\u003c/pre\u003e\u003c/div\u003e\n\u003cdiv class=\"markdown-heading\" dir=\"auto\"\u003e\u003ch2 tabindex=\"-1\" class=\"heading-element\" dir=\"auto\"\u003eRelease Process\u003c/h2\u003e\u003ca id=\"user-content-release-process\" class=\"anchor\" aria-label=\"Permalink: Release Process\" href=\"#release-process\"\u003e\u003csvg class=\"octicon octicon-link\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" height=\"16\" aria-hidden=\"true\"\u003e\u003cpath d=\"m7.775 3.275 1.25-1.25a3.5 3.5 0 1 1 4.95 4.95l-2.5 2.5a3.5 3.5 0 0 1-4.95 0 .751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018 1.998 1.998 0 0 0 2.83 0l2.5-2.5a2.002 2.002 0 0 0-2.83-2.83l-1.25 1.25a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042Zm-4.69 9.64a1.998 1.998 0 0 0 2.83 0l1.25-1.25a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042l-1.25 1.25a3.5 3.5 0 1 1-4.95-4.95l2.5-2.5a3.5 3.5 0 0 1 4.95 0 .751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018 1.998 1.998 0 0 0-2.83 0l-2.5 2.5a1.998 1.998 0 0 0 0 2.83Z\"\u003e\u003c/path\u003e\u003c/svg\u003e\u003c/a\u003e\u003c/div\u003e\n\u003cp dir=\"auto\"\u003eThis documentation is hosted at \u003ca href=\"https://datafusion.apache.org/python\" rel=\"nofollow\"\u003ehttps://datafusion.apache.org/python\u003c/a\u003e\u003c/p\u003e\n\u003cp dir=\"auto\"\u003eWhen the PR is merged to the \u003ccode\u003emain\u003c/code\u003e branch of the DataFusion\nrepository, a \u003ca href=\"https://github.com/apache/datafusion-python/blob/main/.github/workflows/docs.yaml\"\u003egithub workflow\u003c/a\u003e which:\u003c/p\u003e\n\u003col dir=\"auto\"\u003e\n\u003cli\u003eBuilds the html content\u003c/li\u003e\n\u003cli\u003ePushes the html content to the \u003ca href=\"https://github.com/apache/datafusion-python/tree/asf-site\"\u003e\u003ccode\u003easf-site\u003c/code\u003e\u003c/a\u003e branch in this repository.\u003c/li\u003e\n\u003c/ol\u003e\n\u003cp dir=\"auto\"\u003eThe Apache Software Foundation provides \u003ca href=\"https://arrow.apache.org/\" rel=\"nofollow\"\u003ehttps://arrow.apache.org/\u003c/a\u003e,\nwhich serves content based on the configuration in\n\u003ca href=\"https://github.com/apache/datafusion-python/blob/main/.asf.yaml\"\u003e.asf.yaml\u003c/a\u003e,\nwhich specifies the target as \u003ca href=\"https://datafusion.apache.org/python\" rel=\"nofollow\"\u003ehttps://datafusion.apache.org/python\u003c/a\u003e.\u003c/p\u003e\n\u003c/article\u003e","errorMessage":null,"headerInfo":{"toc":[{"level":1,"text":"DataFusion Documentation","anchor":"datafusion-documentation","htmlText":"DataFusion Documentation"},{"level":2,"text":"Dependencies","anchor":"dependencies","htmlText":"Dependencies"},{"level":2,"text":"Build \u0026 Preview","anchor":"build--preview","htmlText":"Build \u0026amp; Preview"},{"level":2,"text":"Release Process","anchor":"release-process","htmlText":"Release Process"}],"siteNavLoginPath":"/login?return_to=https%3A%2F%2Fgithub.com%2Fion-elgreco%2Fdatafusion-python%2Ftree%2Fmain%2Fdocs"}},"totalCount":8,"showBranchInfobar":true},"fileTree":{"":{"items":[{"name":".cargo","path":".cargo","contentType":"directory"},{"name":".github","path":".github","contentType":"directory"},{"name":"benchmarks","path":"benchmarks","contentType":"directory"},{"name":"ci","path":"ci","contentType":"directory"},{"name":"conda","path":"conda","contentType":"directory"},{"name":"dev","path":"dev","contentType":"directory"},{"name":"docs","path":"docs","contentType":"directory"},{"name":"examples","path":"examples","contentType":"directory"},{"name":"parquet","path":"parquet","contentType":"submodule","submoduleUrl":"/apache/parquet-testing/tree/e13af117de7c4f0a4d9908ae3827b3ab119868f3","submoduleDisplayName":"parquet @ e13af11"},{"name":"python","path":"python","contentType":"directory"},{"name":"src","path":"src","contentType":"directory"},{"name":"testing","path":"testing","contentType":"submodule","submoduleUrl":"/apache/arrow-testing/tree/5bab2f264a23f5af68f69ea93d24ef1e8e77fc88","submoduleDisplayName":"testing @ 5bab2f2"},{"name":".asf.yaml","path":".asf.yaml","contentType":"file"},{"name":".dockerignore","path":".dockerignore","contentType":"file"},{"name":".gitignore","path":".gitignore","contentType":"file"},{"name":".gitmodules","path":".gitmodules","contentType":"file"},{"name":".pre-commit-config.yaml","path":".pre-commit-config.yaml","contentType":"file"},{"name":"CHANGELOG.md","path":"CHANGELOG.md","contentType":"file"},{"name":"Cargo.lock","path":"Cargo.lock","contentType":"file"},{"name":"Cargo.toml","path":"Cargo.toml","contentType":"file"},{"name":"LICENSE.txt","path":"LICENSE.txt","contentType":"file"},{"name":"README.md","path":"README.md","contentType":"file"},{"name":"build.rs","path":"build.rs","contentType":"file"},{"name":"pyproject.toml","path":"pyproject.toml","contentType":"file"},{"name":"requirements-310.txt","path":"requirements-310.txt","contentType":"file"},{"name":"requirements-311.txt","path":"requirements-311.txt","contentType":"file"},{"name":"requirements-312.txt","path":"requirements-312.txt","contentType":"file"},{"name":"requirements.in","path":"requirements.in","contentType":"file"}],"totalCount":28}},"fileTreeProcessingTime":20.278807999999998,"foldersToFetch":[],"treeExpanded":true,"symbolsExpanded":false,"csrf_tokens":{"/ion-elgreco/datafusion-python/branches":{"post":"cUllQ510g_GWFzVqgLphuVwIX_wrIyx9XM36LI_g0q8N4WI-5IByTkuwVH8mdgHq-CoEy58pe3wr3u09pJQEaw"},"/ion-elgreco/datafusion-python/branches/fetch_and_merge/main":{"post":"Fk6Wm4bwXIV5Ic0PoGCgrH9YNBUr1g0XWrvUqHG4GntpVWgzmrrhRGRzfQ9sFH7yzFkIkYpZcvftRu0PpIg9Og"},"/ion-elgreco/datafusion-python/branches/fetch_and_merge/main?discard_changes=true":{"post":"43fJCJa9ICxz461hQr2s25XPX9C0Xi-5KtK2GnnIa6WcbDegived7W6xHWGOyXKFJs5jVBXRUFmdL4-9rPhM5A"}}},"title":"datafusion-python/docs at main · ion-elgreco/datafusion-python","appPayload":{"helpUrl":"https://docs.github.com","findFileWorkerPath":"/assets-cdn/worker/find-file-worker-7d7eb7c71814.js","findInFileWorkerPath":"/assets-cdn/worker/find-in-file-worker-1ae9fa256942.js","githubDevUrl":null,"enabled_features":{"code_nav_ui_events":false,"react_blob_overlay":false,"accessible_code_button":true,"github_models_repo_integration":false}}}
You can’t perform that action at this time.