Skip to content

Commit 732d99a

Browse files
Icon updates and documentation references to them
This commit ensures that the new PyMuPDF logo is used for both the README and the documentation. The old logo has been deleted/replaced where appropriate. Additionally the sphinx docs have been updated to include a custom stylesheet and some colors & layout have been adjusted for better accessibility.
1 parent 0b3e09a commit 732d99a

File tree

11 files changed

+38
-8
lines changed

11 files changed

+38
-8
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,4 @@
44
*.swp
55
build/
66
demo/README.rst
7+
docs/build

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# PyMuPDF 1.20.0
22

3-
![logo](https://github.com/pymupdf/PyMuPDF/blob/master/demo/pymupdf.jpg)
3+
![logo](https://artifex.com/images/logos/py-mupdf-github-icon.png?raw=True)
44

55
Release date: June 6, 2022
66

demo/pymupdf.jpg

-37 KB
Binary file not shown.

docs/PyMuPDF.ico

-14.7 KB
Binary file not shown.

docs/_static/PyMuPDF.ico

11.5 KB
Binary file not shown.

docs/_static/custom.css

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
div.sidebar, .sphinxsidebar {
2+
background-color: #333;
3+
}
4+
5+
div.document {
6+
background-color: #333;
7+
}
8+
9+
.sphinxsidebarwrapper .logo {
10+
margin-top: 0;
11+
}
12+
13+
.sphinxsidebarwrapper .logo img {
14+
width: 72px;
15+
height: auto;
16+
}
17+
18+
.sphinxsidebarwrapper ul li {
19+
margin-bottom: 5px;
20+
}
21+
22+
.bodywrapper .body {
23+
min-height: 100vh;
24+
}

docs/conf.py

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@
105105
html_theme_options = {
106106
# "root_name": "",
107107
# "root_url": "",
108-
# "root_icon": "pymupdf.ico",
108+
# "root_icon": "_static/PyMuPDF.ico",
109109
"body_max_width": "none",
110110
"sidebarbgcolor": "gray",
111111
}
@@ -123,18 +123,23 @@
123123

124124
# The name of an image file (relative to this directory) to place at the top
125125
# of the sidebar.
126-
# html_logo = "images/img-pymupdf.jpg"
126+
html_logo = "images/pymupdf-sidebar-logo.png"
127127

128128
# The name of an image file (within the static path) to use as favicon of the
129129
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
130130
# pixels large.
131-
html_favicon = "PyMuPDF.ico"
131+
html_favicon = "_static/PyMuPDF.ico"
132132

133133
# Add any paths that contain custom static files (such as style sheets) here,
134134
# relative to this directory. They are copied after the builtin static files,
135135
# so a file named "default.css" will overwrite the builtin "default.css".
136136
html_static_path = ["_static"]
137137

138+
# A list of CSS files. The entry must be a filename string or a tuple containing
139+
# the filename string and the attributes dictionary. The filename must be
140+
# relative to the html_static_path, or a full URI
141+
html_css_files = ['custom.css']
142+
138143
# Add any extra paths that contain custom files (such as robots.txt or
139144
# .htaccess) here, relative to this directory. These files are copied
140145
# directly to the root of the documentation.
@@ -197,7 +202,7 @@
197202
]
198203
# The name of an image file (relative to this directory) to place at the top of
199204
# the title page.
200-
latex_logo = "images/img-pymupdf.jpg"
205+
latex_logo = "images/pymupdf-logo.png"
201206

202207
# For "manual" documents, if this is true, then toplevel headings are parts,
203208
# not chapters.
@@ -219,7 +224,7 @@
219224
# Grouping the document tree into PDF files. List of tuples
220225
# (source start file, target name, title, author).
221226

222-
pdf_documents = [("index", "PyMuPDF", "PyMuPDF Manual", "Jorj McKie")]
227+
pdf_documents = [("index", "PyMuPDF", "PyMuPDF Manual", "Artifex")]
223228

224229
# A comma-separated list of custom stylesheets. Example:
225230
pdf_stylesheets = ["sphinx", "bahnschrift", "a4"]

docs/images/img-pymupdf.jpg

-125 KB
Binary file not shown.

docs/images/pymupdf-logo.png

47.1 KB
Loading

docs/images/pymupdf-sidebar-logo.png

38.6 KB
Loading

0 commit comments

Comments
 (0)