update links (#35)

kai-tub · Oct 27, 2024 · 640bc0f · 640bc0f
1 parent 15d91ea
commit 640bc0f
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 27 deletions.
diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@
 > A user-friendly introduction to the multi-modal BigEarthNet-MM dataset.
 
 Please take a look at the hosted documentation:
-- [docs.kai-tub.tech/ben-docs/](https://docs.kai-tub.tech/ben-docs/)
+- [kai-tub.github.io/ben-docs/](https://kai-tub.github.io/ben-docs/)
 
 ## Motivation
 <!-- motivation-start -->
@@ -16,4 +16,4 @@ Doing so, will (hopefully) lead to more robust and reliable research down the li
 
 ## Contributing
 Extensive work went towards making it as easy as possible to contribute to and reproduce the work environment.
-Please see the [Contributing](docs.kai-tub.tech/ben-docs/contributing) section of the documentation for more details!
+Please see the [Contributing](kai-tub.github.io/ben-docs/contributing) section of the documentation for more details!
diff --git a/docs/conf.py b/docs/conf.py
@@ -45,7 +45,7 @@
 
 
 intersphinx_mapping = {
-    "ben_gdf_builder": ("https://docs.kai-tub.tech/bigearthnet_gdf_builder", None)
+    "ben_gdf_builder": ("https://kai-tub.github.io/bigearthnet_gdf_builder", None)
 }
 
 # Only useful if sub-urls are accessed
@@ -77,10 +77,10 @@
 
 myst_substitutions = {
     "ben": "[BigEarthNet](https://bigearth.net/)",
-    "BenEncoder": "[BigEarthNet Encoder](https://docs.kai-tub.tech/bigearthnet_encoder/)",
-    "BenInterface": "[BigEarthNet Patch Interface](https://docs.kai-tub.tech/bigearthnet_patch_interface/)",
-    "BenGdfBuilder": "[BigEarthNet GDF Builder](https://docs.kai-tub.tech/bigearthnet_gdf_builder/)",
-    "BenCommon": "[BigEarthNet Common](https://docs.kai-tub.tech/bigearthnet_common/)",
+    "BenEncoder": "[BigEarthNet Encoder](https://kai-tub.github.io/bigearthnet_encoder/)",
+    "BenInterface": "[BigEarthNet Patch Interface](https://kai-tub.github.io/bigearthnet_patch_interface/)",
+    "BenGdfBuilder": "[BigEarthNet GDF Builder](https://kai-tub.github.io/bigearthnet_gdf_builder/)",
+    "BenCommon": "[BigEarthNet Common](https://kai-tub.github.io/bigearthnet_common/)",
     "nix": "[nix](https://nixos.org/explore.html)",
     "devshell": "[devshell](https://numtide.github.io/devshell/)",
     "hypothesis": "[hypothes.is](https://web.hypothes.is/)",

diff --git a/docs/md_representations/raw-data.md b/docs/md_representations/raw-data.md
@@ -273,9 +273,9 @@ from bigearthnet_gdf_builder.builder import add_full_ben_s2_metadata
 
 # also provides a quick way to add important metadata
 # example "metadata" subset
-meta_gdf = add_full_ben_s2_metadata(gdf)
+#meta_gdf = add_full_ben_s2_metadata(gdf)
 # showing first row as tables have display issues
-meta_gdf
+#meta_gdf
 ```
 
 +++ {"tags": []}

diff --git a/docs/raw-data.ipynb b/docs/raw-data.ipynb
@@ -351,24 +351,6 @@
     "].explore()"
    ]
   },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [],
-   "source": [
-    "# scroll-output\n",
-    "from bigearthnet_gdf_builder.builder import add_full_ben_s2_metadata\n",
-    "\n",
-    "# also provides a quick way to add important metadata\n",
-    "# example \"metadata\" subset\n",
-    "meta_gdf = add_full_ben_s2_metadata(gdf)\n",
-    "# showing first row as tables have display issues\n",
-    "meta_gdf"
-   ]
-  },
   {
    "cell_type": "markdown",
    "metadata": {