Skip to content

Commit b257182

Browse files
authored
Merge pull request #177 from pymupdf/updates-READMEs
Fixes some code samples in the READMEs.
2 parents e20b9e7 + 1a9d5dc commit b257182

File tree

3 files changed

+8
-2
lines changed

3 files changed

+8
-2
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,12 @@ To create small **chunks of text** - as opposed to generating one large string f
4242

4343
Also new in version 0.0.2 is the optional **extraction of images** and vector graphics: use of parameter `write_images=True`. The will store PNG images in the document's folder, and the Markdown text will appropriately refer to them. The images are named like `"input.pdf-page_number-index.png"`.
4444

45+
# Documentation and API
46+
47+
[Documentation](https://pymupdf.readthedocs.io/en/latest/pymupdf4llm/index.html)
48+
49+
[API](https://pymupdf.readthedocs.io/en/latest/pymupdf4llm/api.html#pymupdf4llm-api)
50+
4551
# Document Support
4652

4753
While PDF is by far the most important document format worldwide, it is worthwhile mentioning that all examples and helper scripts work in the same way and **_without change_** for [all supported file types](https://pymupdf.readthedocs.io/en/latest/how-to-open-a-file.html#supported-file-types).

pdf4llm/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Instead of the filename string as above, one can also provide a PyMuPDF `Documen
5050
```python
5151
import pdf4llm
5252

53-
md_read = LlamaMarkdownReader()
53+
md_read = pdf4llm.LlamaMarkdownReader()
5454
data = md_read.load_data("input.pdf")
5555

5656
# The result 'data' is of type List[LlamaIndexDocument]

pymupdf4llm/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Instead of the filename string as above, one can also provide a PyMuPDF `Documen
5050
```python
5151
import pymupdf4llm
5252

53-
md_read = LlamaMarkdownReader()
53+
md_read = pymupdf4llm.LlamaMarkdownReader()
5454
data = md_read.load_data("input.pdf")
5555

5656
# The result 'data' is of type List[LlamaIndexDocument]

0 commit comments

Comments
 (0)