More docs updates #4817
Merged
More docs updates #4817
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates documentation across multiple files to improve clarity and consistency regarding PyMuPDF Layout integration. The changes focus on terminology standardization, reference fixes, and enhanced OCR documentation.
Key Changes:
- Standardized terminology from "PyMuPDF-Layout" to "PyMuPDF Layout" and from "layout mode" to more explicit "PyMuPDF Layout" references
- Added visual badges/indicators for PyMuPDF Layout mode parameters in API documentation
- Enhanced OCR support documentation with decision tree and flow diagram
- Fixed reStructuredText reference labels (missing colons)
Reviewed changes
Copilot reviewed 8 out of 11 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/recipes.rst | Reorganized toctree entries, moved recipes-ocr.rst to earlier position |
| docs/pymupdf4llm/index.rst | Fixed reference label, updated terminology from "PyMuPDF-Layout" to "PyMuPDF Layout" |
| docs/pymupdf4llm/api.rst | Added HTML indicators for layout mode parameters, added use_ocr parameter, updated terminology throughout |
| docs/pymupdf-pro/index.rst | Fixed reference label (added missing colon) |
| docs/pymupdf-layout/index.rst | Fixed reference label, added new reference anchors, enhanced OCR section with decision tree, corrected "photographies" to "photographs" |
| docs/installation.rst | Added note with link to official Tesseract documentation (contains typo "documention") |
| docs/locales/ja/LC_MESSAGES/* | Updated Japanese translations to match English changes |
| docs/images/layout-ocr-flow.png | Added new flowchart diagram for OCR decision process |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
JorjMcKie
approved these changes
Nov 28, 2025
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.