Skip to content

Commit

Permalink
remove old docs stuff
Browse files Browse the repository at this point in the history
  • Loading branch information
ianhi committed Feb 24, 2025
1 parent 044e5f5 commit ff2f51e
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 2 deletions.
49 changes: 49 additions & 0 deletions docs/docs/icechunk-python/quickstart2.ipynb
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
{
"cells": [
{
"cell_type": "markdown",
"metadata": {},
"source": [
"\n",
"# Quickstart\n",
"\n",
"Icechunk is designed to be mostly in the background.\n",
"As a Python user, you'll mostly be interacting with Zarr.\n",
"If you're not familiar with Zarr, you may want to start with the [Zarr Tutorial](https://zarr.readthedocs.io/en/latest/tutorial.html)\n",
"\n",
"## Installation\n",
"\n",
"Icechunk can be installed using pip or conda:\n",
"\n",
"=== \"pip\"\n",
"\n",
" ```bash\n",
" python -m pip install icechunk\n",
" ```\n",
"\n",
"=== \"conda\"\n",
"\n",
" ```bash\n",
" conda install -c conda-forge icechunk\n",
" ```\n",
"\n",
"!!! note\n",
"\n",
" Icechunk is currently designed to support the [Zarr V3 Specification](https://zarr-specs.readthedocs.io/en/latest/v3/core/v3.0.html).\n",
" Using it today requires installing Zarr Python 3.\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": []
}
],
"metadata": {
"language_info": {
"name": "python"
}
},
"nbformat": 4,
"nbformat_minor": 2
}
3 changes: 1 addition & 2 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ plugins:
paths: [../icechunk-python/python]
- mkdocs-jupyter:
include_source: True
include: ["*.ipynb"] # Default: ["*.py", "*.ipynb"]
# include: ["*.ipynb"] # Default: ["*.py", "*.ipynb"]
- markdown-exec
# - "icechunk-python/docs/**/*.ipynb"
# - "icechunk-python/docs/docs/icechunk-python/*.ipynb"
Expand Down Expand Up @@ -176,7 +176,6 @@ nav:
- FAQ: faq.md
- Icechunk Python:
- Quickstart: icechunk-python/quickstart.md
- Quickstart2: icechunk-python/quickstart2.ipynb
- Configuration: icechunk-python/configuration.md
- Storage: icechunk-python/storage.md
- FAQ: icechunk-python/faq.md
Expand Down

0 comments on commit ff2f51e

Please sign in to comment.