POC: WIP: DOC/website: Redesign landing page of PyGMT website

README.md

@@ -16,14 +16,17 @@
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 [![CodSpeed Performance Benchmarks](https://img.shields.io/endpoint?url=https://codspeed.io/badge.json)](https://codspeed.io/GenericMappingTools/pygmt)
 
-<!-- doc-index-start-after -->
 
 ## Why PyGMT?
 
+<!-- doc-why-start-after -->
+
 A beautiful map is worth a thousand words. To truly understand how powerful PyGMT is,
 play with it online on [Binder](https://github.com/GenericMappingTools/try-gmt)! For a
 quicker introduction, check out our [3 minute overview](https://youtu.be/4iPnITXrxVU)!
 
+<!-- doc-why-end-before -->
+
 Afterwards, feel free to look at our [Tutorials](https://www.pygmt.org/latest/tutorials),
 visit the [Gallery](https://www.pygmt.org/latest/gallery), and check out some
 [external PyGMT examples](https://www.pygmt.org/latest/external_resources.html)!
@@ -32,13 +35,19 @@ visit the [Gallery](https://www.pygmt.org/latest/gallery), and check out some
 
 ## About
 
+<!-- doc-about-start-after -->
+
 PyGMT is a library for processing geospatial and geophysical data and making
 publication-quality maps and figures. It provides a Pythonic interface for the
 [Generic Mapping Tools (GMT)](https://github.com/GenericMappingTools/gmt), a command-line
 program widely used across the Earth, Ocean, and Planetary sciences and beyond.
 
+<!-- doc-about-end-before -->
+
 ## Project goals
 
+<!-- doc-goals-start-after -->
+
 - Make GMT more accessible to new users.
 - Build a Pythonic API for GMT.
 - Interface with the GMT C API directly using ctypes (no system calls).
@@ -47,6 +56,8 @@ program widely used across the Earth, Ocean, and Planetary sciences and beyond.
   `numpy.ndarray` or `pandas.DataFrame` for data tables, `xarray.DataArray` for grids,
   and `geopandas.GeoDataFrame` for geographical data.
 
+<!-- doc-goals-end-before -->
+
 ## Quickstart
 
 ### Installation
@@ -125,6 +136,8 @@ happy to help others learn.
 
 ## Citing PyGMT
 
+<!-- doc-cite-start-after -->
+
 PyGMT is a community developed project. See the
 [AUTHORS.md](https://github.com/GenericMappingTools/pygmt/blob/main/AUTHORS.md) file
 on GitHub for a list of the people involved and a definition of the term "PyGMT Developers".
@@ -192,6 +205,8 @@ the [GMT 6 paper](https://doi.org/10.1029/2019GC008515) (which PyGMT wraps aroun
 that some modules like `dimfilter`, `surface`, and `x2sys` also have their dedicated
 citations. Further information for all these can be found at <https://www.generic-mapping-tools.org/cite>.
 
+<!-- doc-cite-end-before -->
+
 ## License
 
 PyGMT is free software: you can redistribute it and/or modify it under the terms of the
@@ -200,18 +215,24 @@ PyGMT is free software: you can redistribute it and/or modify it under the terms
 
 ## Support
 
+<!-- doc-support-start-after -->
+
 The development of PyGMT has been supported by NSF grants
 [OCE-1558403](https://www.nsf.gov/awardsearch/show-award/?AWD_ID=1558403) and
 [EAR-1948602](https://www.nsf.gov/awardsearch/show-award/?AWD_ID=1948602).
 
+<!-- doc-support-end-before -->
+
 ## Related projects
 
+<!-- doc-related-start-after -->
+
 Other official wrappers for GMT:
 
 - [GMT.jl](https://github.com/GenericMappingTools/GMT.jl): A Julia wrapper for GMT.
 - [gmtmex](https://github.com/GenericMappingTools/gmtmex): A Matlab/Octave wrapper for GMT.
 
-<!-- doc-index-end-before -->
+<!-- doc-related-end-before -->
 
 ## Minimum supported versions
 

doc/_static/style.css

@@ -71,6 +71,14 @@ p {
     border: solid 2px #b4c7e7;
 }
 
+/* Change color of cards */
+/* https://sphinx-design.readthedocs.io/en/rtd-theme/css_variables.html */
+:root {
+    --sd-color-card-background: #EBF0F9; /* lighter color as top box of sidebar */
+    --sd-color-card-header: #b4c7e7; /* same color as top box of sidebar */
+    --sd-color-card-footer: #FFFFFF; /* white */
+}
+
 /* Format parameters section similar to sphinx_rtd_theme v4.x.x (not a grid) */
 html.writer-html5 .rst-content dl.field-list {
     display: initial;

doc/citing.md

@@ -0,0 +1,6 @@
+# Citing PyGMT
+
+```{include} ../README.md
+:start-after: <!-- doc-cite-start-after -->
+:end-before: <!-- doc-cite-end-before -->
+```

doc/conf.py

@@ -211,20 +211,20 @@
 html_context = {
     "menu_links": [
         (
-            '<i class="fa fa-gavel fa-fw"></i> Code of Conduct',
-            "https://github.com/GenericMappingTools/.github/blob/main/CODE_OF_CONDUCT.md",
+            '<i class="fa fa-comment fa-fw"></i> GMT Forum',
+            "https://forum.generic-mapping-tools.org",
         ),
         (
-            '<i class="fa fa-book fa-fw"></i> License',
-            f"{repository_url}/blob/main/LICENSE.txt",
+            '<i class="fa fa-github fa-fw"></i> Source Code',
+            repository_url,
         ),
         (
-            '<i class="fa fa-comment fa-fw"></i> Contact',
-            "https://forum.generic-mapping-tools.org",
+            '<i class="fa fa-gavel fa-fw"></i> Code of Conduct',
+            "https://github.com/GenericMappingTools/.github/blob/main/CODE_OF_CONDUCT.md",
         ),
         (
-            '<i class="fa fa-github fa-fw"></i> Source Code',
-            repository_url,
+            '<i class="fa fa-book fa-fw"></i> License',
+            f"{repository_url}/blob/main/LICENSE.txt",
         ),
     ],
     # Custom variables to enable "Improve this page"" and "Download notebook" links

doc/external_resources.md

@@ -12,111 +12,133 @@ to submit a pull request with your recommended addition to the
 
 :::::{grid} 1 2 2 3
 
-::::{grid-item-card} 2024 AGU PREWS9: Mastering Geospatial Visualizations with GMT/PyGMT
+::::{grid-item-card}
 :link: https://www.generic-mapping-tools.org/agu24workshop/
 :text-align: center
 :margin: 0 3 0 0
 
+**2024 AGU PREWS9: Mastering Geospatial Visualizations with GMT/PyGMT**
+^^^
 ![](https://github.com/user-attachments/assets/9f3ab0ed-83f1-4cff-bc68-387fc13ca61f)
 +++
 Wei Ji Leong, Yvonne Fröhlich, Jing-Hui Tong, Federico Esteban, Max Jones, Andre Belem
 ::::
 
-::::{grid-item-card} 2024 PyGMT Webinar using Google Colab (in Portuguese)
+::::{grid-item-card}
 :link: https://github.com/andrebelem/Oficina_PyGMT
 :text-align: center
 :margin: 0 3 0 0
 
+**2024 PyGMT Webinar using Google Colab (in Portuguese)**
+^^^
 ![](https://github.com/andrebelem/Oficina_PyGMT/raw/main/Datasets/3D_sample.png)
 +++
 Andre Belem
 ::::
 
-::::{grid-item-card} 2022 EGU SC5.2: Crafting beautiful maps with PyGMT
+::::{grid-item-card}
 :link: https://www.generic-mapping-tools.org/egu22pygmt/
 :text-align: center
 :margin: 0 3 0 0
 
+**2022 EGU SC5.2: Crafting beautiful maps with PyGMT**
+^^^
 ![](https://user-images.githubusercontent.com/3974108/171653272-efaceeb1-a253-44a1-bddc-36bc9498c19b.png)
 +++
 Wei Ji Leong, Leonardo Uieda, Max Jones, Andre Belem
 ::::
 
-::::{grid-item-card} 2021 PyGMT course at the UAF Geophysical Institute
+::::{grid-item-card}
 :link: https://github.com/liamtoney/gi-pygmt-2021
 :text-align: center
 :margin: 0 3 0 0
 
+**2021 PyGMT course at the UAF Geophysical Institute**
+^^^
 ![](https://user-images.githubusercontent.com/3974108/172042115-3f700c16-0f78-49d3-9e8d-87c77e4c0444.png)
 +++
 Liam Toney
 ::::
 
-::::{grid-item-card} 2021 Remote Online Sessions for Emerging Seismologists (ROSES): Unit 5 - Mapping
+::::{grid-item-card}
 :link: https://www.youtube.com/watch?v=Zvcy7VDuhiw
 :text-align: center
 :margin: 0 3 0 0
 
+**2021 Remote Online Sessions for Emerging Seismologists (ROSES): Unit 5 - Mapping**
+^^^
 ![](https://user-images.githubusercontent.com/3974108/172055872-b81057b6-aef3-473f-8f42-1cc82a68d188.jpg)
 +++
 Liam Toney
 ::::
 
-::::{grid-item-card} 2020 Remote Online Sessions for Emerging Seismologists (ROSES): Unit 8 - PyGMT
+::::{grid-item-card}
 :link: https://www.iris.edu/hq/inclass/lesson/728
 :text-align: center
 :margin: 0 3 0 0
 
+**2020 Remote Online Sessions for Emerging Seismologists (ROSES): Unit 8 - PyGMT**
+^^^
 ![](https://user-images.githubusercontent.com/3974108/172055922-8df68c00-4115-42f4-83ae-13a971fef846.png)
 +++
 Liam Toney
 ::::
 
-::::{grid-item-card} PyGMT Tutorial in 2021
+::::{grid-item-card}
 :link: https://github.com/MIGG-NTU/PyGMT2021
 :text-align: center
 :margin: 0 3 0 0
 
+**2021 PyGMT Tutorial**
+^^^
 ![](https://user-images.githubusercontent.com/23487320/172058757-9b68f7ae-7a3f-4f48-9df6-9a065d6cd448.png)
 +++
 MIGG-NTU
 ::::
 
-::::{grid-item-card} PyGMT Workshop at FOSS4G Oceania 2019
+::::{grid-item-card}
 :link: https://github.com/GenericMappingTools/foss4g2019oceania
 :text-align: center
 :margin: 0 3 0 0
 
+**2019 PyGMT Workshop at FOSS4G Oceania**
+^^^
 ![](https://github.com/GenericMappingTools/foss4g2019oceania/releases/download/v1/picton_3d_dsm_view.png)
 +++
 Wei Ji Leong
 ::::
 
-::::{grid-item-card} Crafting 3D maps of Antarctica with PyGMT and the IBCSO V2
+::::{grid-item-card}
 :link: https://github.com/andrebelem/3D-Antarctic-maps
 :text-align: center
 :margin: 0 3 0 0
 
+**Crafting 3D maps of Antarctica with PyGMT and the IBCSO V2**
+^^^
 ![](https://github.com/andrebelem/3D-Antarctic-maps/raw/main/3D-Antarctic-Maps.png)
 +++
 Andre Belem
 ::::
 
-::::{grid-item-card} Planetary Maps (in PyGMT)
+::::{grid-item-card}
 :link: https://github.com/andrebelem/PlanetaryMaps
 :text-align: center
 :margin: 0 3 0 0
 
+**Planetary Maps (in PyGMT)**
+^^^
 ![](https://github.com/andrebelem/MarsMaps/raw/main/JezeroCrater.png)
 +++
 Andre Belem
 ::::
 
-::::{grid-item-card} PyGMT-HOWTO
+::::{grid-item-card}
 :link: https://tktmyd.github.io/pygmt-howto-jp/
 :text-align: center
 :margin: 0 3 0 0
 
+**PyGMT-HOWTO**
+^^^
 ![](https://github.com/tktmyd/pygmt-howto-jp/raw/main/src/basics/fig/pygmt-coastline.png)
 +++
 Takuto Maeda
@@ -128,31 +150,37 @@ Takuto Maeda
 
 :::::{grid} 1 2 2 3
 
-::::{grid-item-card} GMT and PyGMT plotting examples
+::::{grid-item-card}
 :link: https://github.com/michaelgrund/GMT-plotting
 :text-align: center
 :margin: 0 3 0 0
 
+**GMT and PyGMT plotting examples**
+^^^
 ![](https://user-images.githubusercontent.com/3974108/172055991-c0646f6c-d130-474f-b46a-5587483998cb.jpg)
 +++
 Michael Grund
 ::::
 
-::::{grid-item-card} NZ Antarctic Science Conference 2021 poster
+::::{grid-item-card}
 :link: https://github.com/weiji14/nzasc2021
 :text-align: center
 :margin: 0 3 0 0
 
+**NZ Antarctic Science Conference 2021 poster**
+^^^
 ![](https://user-images.githubusercontent.com/23487320/107176140-6aa4e580-6a33-11eb-8f30-1a7913788d6c.png)
 +++
 Wei Ji Leong
 ::::
 
-::::{grid-item-card} PyGMT plotting examples
+::::{grid-item-card}
 :link: https://github.com/yvonnefroehlich/gmt-pygmt-plotting
 :text-align: center
 :margin: 0 3 0 0
 
+**PyGMT plotting examples**
+^^^
 ![](https://github.com/yvonnefroehlich/gmt-pygmt-plotting/raw/main/_images/github_maps_readme_main.png)
 +++
 Yvonne Fröhlich