Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

POC: Add PyGMT logo to README & docs #3845

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Conversation

michaelgrund
Copy link
Member

@michaelgrund michaelgrund commented Mar 11, 2025

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.

Preview:

screen_pygmt

Reminders

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
  • If adding new functionality, add an example to docstrings or tutorials.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash command is:

  • /format: automatically format and lint the code

@michaelgrund michaelgrund 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
@michaelgrund michaelgrund changed the title POC: Add PyGMT logo to README POC: Add PyGMT logo to README & docs Mar 11, 2025
@seisman
Copy link
Member

seisman commented Mar 11, 2025

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.

@seisman
Copy link
Member

seisman commented Mar 12, 2025

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants