1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
|
# PyMuPDF documentation
Welcome to the PyMuPDF documentation. This documentation relies on [Sphinx](https://www.sphinx-doc.org/en/master/) to publish HTML docs from markdown files written with [restructured text](https://en.wikipedia.org/wiki/ReStructuredText) (RST).
## Sphinx version
This README assumes you have [Sphinx v5.0.2 installed](https://www.sphinx-doc.org/en/master/usage/installation.html) on your system.
## Updating the documentation
Within `docs` update the associated restructured text (`.rst`) files. These files represent the corresponding document pages.
## Building HTML documentation
- Ensure you have the `sphinx-rtd-theme` installed:
`python -m pip install sphinx-rtd-theme`
- From the "docs" location run:
`sphinx-build -b html . build/html`
This then creates the HTML documentation within `build/html`.
## Building PDF documentation
- First ensure you have [rst2pdf](https://pypi.org/project/rst2pdf/) installed:
`python -m pip install rst2pdf`
- Then run:
`sphinx-build -b pdf source build/pdf`
This will then generate a single PDF for all of the documentation within `build/pdf`.
---
For full details see: [Using Sphinx](https://www.sphinx-doc.org/en/master/usage/index.html)
|
