docs: update

nakamura196 · Jan 29, 2025 · 39030ed · 39030ed
1 parent 622a677
commit 39030ed
Show file tree

Hide file tree

Showing 12 changed files with 81 additions and 213 deletions.
diff --git a/01_demo.ipynb b/01_demo.ipynb
@@ -8,7 +8,7 @@
    "source": [
     "%reload_ext autoreload\n",
     "%autoreload 2\n",
-    "from genji_ocr.core import CoreClient\n",
+    "from ndlkotensekiocr_tools.core import CoreClient\n",
     "client = CoreClient()"
    ]
   },

diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-genji_ocr
+ndlkotensekiocr_tools
 ================
 
 <!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
@@ -11,16 +11,16 @@ documentation.
 If you are new to using `nbdev` here are some useful pointers to get you
 started.
 
-### Install genji_ocr in Development mode
+### Install ndlkotensekiocr_tools in Development mode
 
 ``` sh
-# make sure genji_ocr package is installed in development mode
+# make sure ndlkotensekiocr_tools package is installed in development mode
 $ pip install -e .
 
 # make changes under nbs/ directory
 # ...
 
-# compile to have changes apply to genji_ocr
+# compile to have changes apply to ndlkotensekiocr_tools
 $ nbdev_prepare
 ```
 
@@ -29,32 +29,32 @@ $ nbdev_prepare
 ### Installation
 
 Install latest from the GitHub
-[repository](https://github.com/nakamura196/genji_ocr):
+[repository](https://github.com/nakamura196/ndlkotensekiocr_tools):
 
 ``` sh
-$ pip install git+https://github.com/nakamura196/genji_ocr.git
+$ pip install git+https://github.com/nakamura196/ndlkotensekiocr_tools.git
 ```
 
-or from [conda](https://anaconda.org/nakamura196/genji_ocr)
+or from [conda](https://anaconda.org/nakamura196/ndlkotensekiocr_tools)
 
 ``` sh
-$ conda install -c nakamura196 genji_ocr
+$ conda install -c nakamura196 ndlkotensekiocr_tools
 ```
 
-or from [pypi](https://pypi.org/project/genji_ocr/)
+or from [pypi](https://pypi.org/project/ndlkotensekiocr_tools/)
 
 ``` sh
-$ pip install genji_ocr
+$ pip install ndlkotensekiocr_tools
 ```
 
 ### Documentation
 
 Documentation can be found hosted on this GitHub
-[repository](https://github.com/nakamura196/genji_ocr)’s
-[pages](https://nakamura196.github.io/genji_ocr/). Additionally you can
-find package manager specific guidelines on
-[conda](https://anaconda.org/nakamura196/genji_ocr) and
-[pypi](https://pypi.org/project/genji_ocr/) respectively.
+[repository](https://github.com/nakamura196/ndlkotensekiocr_tools)’s
+[pages](https://nakamura196.github.io/ndlkotensekiocr_tools/).
+Additionally you can find package manager specific guidelines on
+[conda](https://anaconda.org/nakamura196/ndlkotensekiocr_tools) and
+[pypi](https://pypi.org/project/ndlkotensekiocr_tools/) respectively.
 
 ## How to use
 

diff --git a/genji_ocr/_modidx.py b/genji_ocr/_modidx.py
diff --git a/nbs/00_core.ipynb b/nbs/00_core.ipynb
@@ -11,7 +11,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 86,
+   "execution_count": null,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -20,7 +20,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 87,
+   "execution_count": null,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -30,7 +30,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 88,
+   "execution_count": null,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -48,7 +48,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 89,
+   "execution_count": null,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -340,7 +340,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 90,
+   "execution_count": null,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -354,18 +354,6 @@
    "display_name": "python3",
    "language": "python",
    "name": "python3"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.9.11"
   }
  },
  "nbformat": 4,

diff --git a/nbs/index.ipynb b/nbs/index.ipynb
@@ -7,14 +7,14 @@
    "outputs": [],
    "source": [
     "#| hide\n",
-    "from genji_ocr.core import *"
+    "from ndlkotensekiocr_tools.core import *"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# genji_ocr\n",
+    "# ndlkotensekiocr_tools\n",
     "\n",
     "> "
    ]
@@ -23,44 +23,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "This file will become your README and also the index of your documentation."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Developer Guide"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "If you are new to using `nbdev` here are some useful pointers to get you started."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Install genji_ocr in Development mode"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "```sh\n",
-    "# make sure genji_ocr package is installed in development mode\n",
-    "$ pip install -e .\n",
-    "\n",
-    "# make changes under nbs/ directory\n",
-    "# ...\n",
-    "\n",
-    "# compile to have changes apply to genji_ocr\n",
-    "$ nbdev_prepare\n",
-    "```"
+    "[ndlkotenocr-lite](https://github.com/ndl-lab/ndlkotenocr-lite)を用いたツールを提供します。"
    ]
   },
   {
@@ -74,117 +37,15 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Installation"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Install latest from the GitHub [repository][repo]:\n",
-    "\n",
-    "```sh\n",
-    "$ pip install git+https://github.com/nakamura196/genji_ocr.git\n",
-    "```\n",
-    "\n",
-    "or from [conda][conda]\n",
-    "\n",
-    "```sh\n",
-    "$ conda install -c nakamura196 genji_ocr\n",
-    "```\n",
-    "\n",
-    "or from [pypi][pypi]\n",
-    "\n",
-    "\n",
-    "```sh\n",
-    "$ pip install genji_ocr\n",
-    "```\n",
-    "\n",
-    "\n",
-    "[repo]: https://github.com/nakamura196/genji_ocr\n",
-    "[docs]: https://nakamura196.github.io/genji_ocr/\n",
-    "[pypi]: https://pypi.org/project/genji_ocr/\n",
-    "[conda]: https://anaconda.org/nakamura196/genji_ocr"
+    "[こちら](https://colab.research.google.com/github/nakamura196/000_tools/blob/main/IIIF%E3%83%9E%E3%83%8B%E3%83%95%E3%82%A7%E3%82%B9%E3%83%88%E3%83%95%E3%82%A1%E3%82%A4%E3%83%AB%E3%81%8B%E3%82%89TEI_XML%E3%83%95%E3%82%A1%E3%82%A4%E3%83%AB%E3%82%92%E4%BD%9C%E6%88%90%E3%81%99%E3%82%8B%E3%83%97%E3%83%AD%E3%82%B0%E3%83%A9%E3%83%A0.ipynb)のノートブックを参考にしてください。"
    ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Documentation"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Documentation can be found hosted on this GitHub [repository][repo]'s [pages][docs]. Additionally you can find package manager specific guidelines on [conda][conda] and [pypi][pypi] respectively.\n",
-    "\n",
-    "[repo]: https://github.com/nakamura196/genji_ocr\n",
-    "[docs]: https://nakamura196.github.io/genji_ocr/\n",
-    "[pypi]: https://pypi.org/project/genji_ocr/\n",
-    "[conda]: https://anaconda.org/nakamura196/genji_ocr"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## How to use"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Fill me in please! Don't forget code examples:"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "2"
-      ]
-     },
-     "execution_count": null,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "1+1"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": []
   }
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
+   "display_name": "python3",
    "language": "python",
    "name": "python3"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.11.8"
   }
  },
  "nbformat": 4,

diff --git a/nbs/nbdev.yml b/nbs/nbdev.yml
@@ -2,8 +2,8 @@ project:
   output-dir: _docs
 
 website:
-  title: "genji_ocr"
-  site-url: "https://nakamura196.github.io/genji_ocr"
+  title: "ndlkotensekiocr_tools"
+  site-url: "https://nakamura196.github.io/ndlkotensekiocr_tools"
   description: ""
   repo-branch: main
-  repo-url: "https://github.com/nakamura196/genji_ocr"
+  repo-url: "https://github.com/nakamura196/ndlkotensekiocr_tools"
diff --git a/nbs/sidebar.yml b/nbs/sidebar.yml
@@ -0,0 +1,5 @@
+website:
+  sidebar:
+    contents:
+      - index.ipynb
+      - 00_core.ipynb
diff --git a/genji_ocr/__init__.py → ndlkotensekiocr_tools/__init__.py b/genji_ocr/__init__.py → ndlkotensekiocr_tools/__init__.py