Skip to content

DOC: Add PyGMT logo to README & docs - #3845

Merged
seisman merged 32 commits into
mainfrom
add-pygmt-logo
Jul 6, 2026
Merged

DOC: Add PyGMT logo to README & docs#3845
seisman merged 32 commits into
mainfrom
add-pygmt-logo

Conversation

@michaelgrund

@michaelgrundmichaelgrund commented Mar 11, 2025

Copy link
Copy Markdown
Member

Description of proposed changes

Since we now have a logo (#1404) we should think about in which format we want to place it in our README/docs. I would suggest to use the horizontal one. Would also suggest to add the subtitle A Python interface for the Generic Mapping Tools. Maybe @sfrooti may add that to the prepared logos. Also need to increase the resolution. Finally, the yellow lines do not really stand out from the background.

  • Landing page
  • Sidebar
  • Favicon
  • GitHub README

Previews:

favicon

image

@michaelgrundmichaelgrund added the documentation Improvements or additions to documentation label Mar 11, 2025
@michaelgrund
michaelgrund marked this pull request as draft March 11, 2025 08:25
@michaelgrundmichaelgrund changed the title POC: Add PyGMT logo to READMEPOC: Add PyGMT logo to README & docsMar 11, 2025
@seisman

Copy link
Copy Markdown
Member

Thanks for opening the PR so that we can better preview what the logo looks like on the web or PDF. Just want to note that the logo is not finalized yet, and we may tweak the logo based on the community responses.

@seismanseisman mentioned this pull request Mar 12, 2025
@seisman

Copy link
Copy Markdown
Member

@michaelgrund Please help replace the favicon doc/_static/favicon.png, and also maybe add a logo to the title at the sidebar by setting html_logo to an image path in doc/conf.py.

@michaelgrund
michaelgrund marked this pull request as ready for review March 14, 2025 08:39
@michaelgrund

Copy link
Copy Markdown
MemberAuthor

@michaelgrund Please help replace the favicon doc/_static/favicon.png, and also maybe add a logo to the title at the sidebar by setting html_logo to an image path in doc/conf.py.

Not sure if it works with direct URL references like I did.

@seisman

Copy link
Copy Markdown
Member

@michaelgrund Please help replace the favicon doc/_static/favicon.png, and also maybe add a logo to the title at the sidebar by setting html_logo to an image path in doc/conf.py.

Not sure if it works with direct URL references like I did.

It seems not working. Could you please add the static images to the repository instead? The PyGMT banner on the landing page also needs to be updated

pygmt/doc/index.md

Lines 4 to 10 in eb0ebe7

<divclass="banner">
<h1>PyGMT<h1>
<h2>
A Python interface for the
<a href="https://www.generic-mapping-tools.org/">Generic Mapping Tools</a>
</h2>
</div>

Comment threaddoc/conf.py Outdated
Comment threaddoc/index.md Outdated
michaelgrundand others added 2 commits March 17, 2025 10:12
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@michaelgrund

Copy link
Copy Markdown
MemberAuthor

FYI, currently the original images stored in @sfrooti's repo are saved in our doc/_static/. When the logo refinements are done I suggest to generate the needed versions as static pngs and store them instead of the currently used ones.

@seismanseisman added this to the 0.19.0 milestone May 19, 2026
@seismanseisman mentioned this pull request May 21, 2026
43 tasks
@seismanseisman changed the title POC: Add PyGMT logo to README & docsAdd PyGMT logo to README & docsJun 24, 2026
@seismanseisman mentioned this pull request Jul 2, 2026
23 tasks
@yvonnefroehlichyvonnefroehlich changed the title Add PyGMT logo to README & docsDOC: Add PyGMT logo to README & docsJul 4, 2026
@seisman
seisman marked this pull request as ready for review July 4, 2026 16:03
@seismanseisman added skip-changelog Skip adding Pull Request to changelog final review call This PR requires final review and approval from a second reviewer labels Jul 4, 2026
@yvonnefroehlich

Copy link
Copy Markdown
Member

I am a bit debating on using the dark theme logo for the side bar, because of blue (dark) background there.
This improves the readbility of the wordmark.

sidebar with light logosidebar with dark logo
sidebar_light_logosidebar_dark_logo

@michaelgrund

Copy link
Copy Markdown
MemberAuthor

I am a bit debating on using the dark theme logo for the side bar, because of blue (dark) background there. This improves the readbility of the wordmark.

sidebar with light logo sidebar with dark logo
sidebar_light_logosidebar_dark_logo

Agree, with the light version, at least the "Py" part is hard to read on the blue background of the sidebar.

@seisman

Copy link
Copy Markdown
Member

I agree. what if we change the sidebar color?

@yvonnefroehlich

yvonnefroehlich commented Jul 5, 2026

Copy link
Copy Markdown
Member

I agree. what if we change the sidebar color?

Just looked, and it seems possible to change the fill color of the box at the top of the sidebar via adding

/* Change background color of sidebar top box with logo, version and search bar */
.wy-side-nav-search {
background:#b4c7e7;
}

to the doc\_static\style.css file (xref: https://stackoverflow.com/a/54304990/20936303).

Changing the color of this box would help to also improve the contract between the blue circle of the logo and the background. Any preferences on the color? Maybe just keep blue, but a ligther hue:

sidebar_light_logosidebar_lightblue

@seisman

Copy link
Copy Markdown
Member

The new color looks good

@yvonnefroehlich

yvonnefroehlich commented Jul 5, 2026

Copy link
Copy Markdown
Member

The new color looks good

Fine. Include this color change in this PR or have a separat one?
@michaelgrund any comments on the color?

pygmt_website_sidebarcolor_logo

@michaelgrund

Copy link
Copy Markdown
MemberAuthor

The new color looks good

Fine. Include this color change in this PR or have a separat one? @michaelgrund any comments on the color?

pygmt_website_sidebarcolor_logo

Looks good!

@seismanseisman removed the final review call This PR requires final review and approval from a second reviewer label Jul 6, 2026
@seisman
seisman merged commit 8b473a5 into mainJul 6, 2026
9 of 10 checks passed
@seisman
seisman deleted the add-pygmt-logo branch July 6, 2026 05:24
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentationImprovements or additions to documentationskip-changelogSkip adding Pull Request to changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@michaelgrund@seisman@yvonnefroehlich