Skip to content

Commit ca2e01f

Browse files
committed
Some small visual formatting.
1 parent 76c41f7 commit ca2e01f

File tree

3 files changed

+21
-3
lines changed

3 files changed

+21
-3
lines changed

docs/src/_static/custom.css

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
/* add custom CSS as required */
22
.footer-item .theme-version {
33
display: none;
4+
}
5+
6+
cite {
7+
font-weight: bold;
8+
font-style: normal;
49
}

docs/src/api.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ API
1212

1313
.. method:: to_markdown(doc: pymupdf.Document | str, *, pages: list | range | None = None, hdr_info: Any = None, write_images: bool = False, margins=(0, 50, 0, 50), page_chunks: bool = False) -> str | list[dict]
1414

15-
Read the pages of the file and outputs the text of its pages in Markdown format. How this should happen in detail can be influenced by a number of parameters. Please note that there exists support for building page chunks from the Markdown text.
15+
Read the pages of the file and outputs the text of its pages in |Markdown| format. How this should happen in detail can be influenced by a number of parameters. Please note that there exists support for building page chunks from the |Markdown| text.
1616

17-
:arg Document,str doc: the file, to be specified either as a file path string, or as a PyMuPDF Document (created via `pymupdf.open`).
17+
:arg Document,str doc: the file, to be specified either as a file path string, or as a |PyMuPDF| Document (created via `pymupdf.open`).
1818

1919
:arg list,range pages: optional, the pages to consider for output. If omitted all pages are processed.
2020

@@ -28,7 +28,7 @@ API
2828

2929
- **"metadata"** - a dictionary consisting of the document's metadata `Document.metadata <https://pymupdf.readthedocs.io/en/latest/document.html#Document.metadata>`_, enriched with additional keys **"file_path"** (the file name), **"page_count"** (number of pages in document), and **"page_number"** (1-based page number).
3030

31-
- **"toc_items"** - a list of Table of Contents items pointing to this page. Each item of this list has the format `[lvl, title, pagenumber]`, where "lvl" is the hierachy level, "title" a string and "pagenumber" the 12-based page number.
31+
- **"toc_items"** - a list of Table of Contents items pointing to this page. Each item of this list has the format `[lvl, title, pagenumber]`, where `lvl` is the hierachy level, `title` a string and `pagenumber` the 12-based page number.
3232

3333
- **"tables"** - a list of tables on this page. Each item is a dictionary with keys "bbox", "row_count" and "col_count". Key "bbox" is a `pymupdf.Rect` in tuple format of the table's position on the page.
3434

docs/src/header.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,16 @@
1+
.. |PyMuPDF| raw:: html
2+
3+
<cite>PyMuPDF</cite>
4+
5+
.. |PDF| raw:: html
6+
7+
<cite>PDF</cite>
8+
9+
.. |Markdown| raw:: html
10+
11+
<cite>Markdown</cite>
12+
13+
114
.. raw:: html
215

316
<style>

0 commit comments

Comments
 (0)