From 69161f344d2ffeb1c9715e3d8a62309d03b11f63 Mon Sep 17 00:00:00 2001 From: Ubuntu Date: Tue, 1 Oct 2024 14:55:40 +0000 Subject: [PATCH] improve docs --- examples/async_pdf_to_markdown.ipynb | 32 ++++++++++++++-------------- examples/docx_to_markdown.ipynb | 8 +++---- examples/image_to_markdown.ipynb | 8 +++---- examples/pdf_to_markdown.ipynb | 32 ++++++++++++++-------------- 4 files changed, 40 insertions(+), 40 deletions(-) diff --git a/examples/async_pdf_to_markdown.ipynb b/examples/async_pdf_to_markdown.ipynb index 0823eba..683d9a7 100644 --- a/examples/async_pdf_to_markdown.ipynb +++ b/examples/async_pdf_to_markdown.ipynb @@ -8,20 +8,20 @@ "\n", "Below is an example of using AnyParser asynchronous API to accurately extract the layout and text from a sample PDF into markdown format. \n", "\n", - "As a prerequisite, install the Poppler PDF rendering library:\n", + "To load the preview for the PDF document used in this demo, install the Poppler PDF rendering library:\n", "- Mac:\n", - " ```\n", - " brew install poppler\n", - " ```\n", + "```bash\n", + "brew install poppler\n", + "```\n", "- Linux:\n", - " ```\n", - " sudo apt update\n", - " sudo apt install poppler-utils\n", - " ```\n", + "```bash\n", + "sudo apt update\n", + "sudo apt install poppler-utils\n", + "```\n", "- Windows:\n", - " ```\n", - " choco install poppler\n", - " ```\n", + "```bash\n", + "choco install poppler\n", + "```\n", "\n", "### 1. Load the libraries\n", "\n", @@ -42,7 +42,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "Next, to use AnyParser, either install the public package or install the SDK locally." + "Next, to use AnyParser, either install the public package or clone the SDK locally." ] }, { @@ -55,10 +55,10 @@ "# !pip3 install --upgrade any-parser\n", "\n", "# Option 2: if you have sdk respository installed locally, add system path\n", - "import sys\n", - "sys.path.append(\".\")\n", - "sys.path.append(\"..\")\n", - "sys.path.append(\"../..\")" + "# import sys\n", + "# sys.path.append(\".\")\n", + "# sys.path.append(\"..\")\n", + "# sys.path.append(\"../..\")" ] }, { diff --git a/examples/docx_to_markdown.ipynb b/examples/docx_to_markdown.ipynb index 4510d0b..fd26c45 100644 --- a/examples/docx_to_markdown.ipynb +++ b/examples/docx_to_markdown.ipynb @@ -42,10 +42,10 @@ "# !pip3 install --upgrade any-parser\n", "\n", "# Option 2: if you have sdk respository installed locally, add system path\n", - "import sys\n", - "sys.path.append(\".\")\n", - "sys.path.append(\"..\")\n", - "sys.path.append(\"../..\")" + "# import sys\n", + "# sys.path.append(\".\")\n", + "# sys.path.append(\"..\")\n", + "# sys.path.append(\"../..\")" ] }, { diff --git a/examples/image_to_markdown.ipynb b/examples/image_to_markdown.ipynb index 0ad296c..e908a81 100644 --- a/examples/image_to_markdown.ipynb +++ b/examples/image_to_markdown.ipynb @@ -40,10 +40,10 @@ "# !pip3 install --upgrade any-parser\n", "\n", "# Option 2: if you have sdk respository installed locally, add system path\n", - "import sys\n", - "sys.path.append(\".\")\n", - "sys.path.append(\"..\")\n", - "sys.path.append(\"../..\")" + "# import sys\n", + "# sys.path.append(\".\")\n", + "# sys.path.append(\"..\")\n", + "# sys.path.append(\"../..\")" ] }, { diff --git a/examples/pdf_to_markdown.ipynb b/examples/pdf_to_markdown.ipynb index 1aaa67b..782d232 100644 --- a/examples/pdf_to_markdown.ipynb +++ b/examples/pdf_to_markdown.ipynb @@ -8,20 +8,20 @@ "\n", "Below is an example of using AnyParser to accurately extract the layout and text from a sample PDF into markdown format.\n", "\n", - "As a prerequisite, install the Poppler PDF rendering library:\n", + "To load the preview for the PDF document used in this demo, install the Poppler PDF rendering library:\n", "- Mac:\n", - " ```\n", - " brew install poppler\n", - " ```\n", + "```bash\n", + "brew install poppler\n", + "```\n", "- Linux:\n", - " ```\n", - " sudo apt update\n", - " sudo apt install poppler-utils\n", - " ```\n", + "```bash\n", + "sudo apt update\n", + "sudo apt install poppler-utils\n", + "```\n", "- Windows:\n", - " ```\n", - " choco install poppler\n", - " ```\n", + "```bash\n", + "choco install poppler\n", + "```\n", "\n", "### 1. Load the libraries\n", "\n", @@ -42,7 +42,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "Next, to use AnyParser, either install the public package or install the SDK locally." + "Next, to use AnyParser, either install the public package or clone the SDK locally." ] }, { @@ -55,10 +55,10 @@ "# !pip3 install --upgrade any-parser\n", "\n", "# Option 2: if you have sdk respository installed locally, add system path\n", - "import sys\n", - "sys.path.append(\".\")\n", - "sys.path.append(\"..\")\n", - "sys.path.append(\"../..\")" + "# import sys\n", + "# sys.path.append(\".\")\n", + "# sys.path.append(\"..\")\n", + "# sys.path.append(\"../..\")" ] }, {