Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
89 commits
Select commit Hold shift + click to select a range
6c0f26a
Use cards for landing page, add section 'Project overview', recorder …
yvonnefroehlich Jul 25, 2026
76f81be
Improve layout of cards (not: affect also extral resources)
yvonnefroehlich Jul 25, 2026
431ff91
Adjust / test card layout for external resources
yvonnefroehlich Jul 25, 2026
6122a6a
Try to set up real bullet point list
yvonnefroehlich Jul 25, 2026
cbb82d0
Fix replace error
yvonnefroehlich Jul 25, 2026
70b9c56
Make formulations idential
yvonnefroehlich Jul 25, 2026
e549b48
Remove un-needed new lines
yvonnefroehlich Jul 25, 2026
83b7159
Split README content into pages for docs
yvonnefroehlich Jul 25, 2026
0cfe97f
Remove execution permission
yvonnefroehlich Jul 25, 2026
ffd35b3
Add icons
yvonnefroehlich Jul 25, 2026
4f2a889
Center text on landing page
yvonnefroehlich Jul 25, 2026
7f18fe2
Adjust font size and lower padding of text on lading page
yvonnefroehlich Jul 25, 2026
142fb15
Add logo on landing page via sphinx markdown instead of html
yvonnefroehlich Jul 25, 2026
f572808
Remove blank lines and with spaces
yvonnefroehlich Jul 25, 2026
7606c48
Prepare for links
yvonnefroehlich Jul 25, 2026
6405409
Test links without shared website URL
yvonnefroehlich Jul 25, 2026
772333d
Remove links from cards, add links to bullet point list
yvonnefroehlich Jul 26, 2026
e44f69e
Rewrite text in doc to have link linking to selected version
yvonnefroehlich Jul 26, 2026
34aea2e
Improve text for 'Why PyGMT'
yvonnefroehlich Jul 26, 2026
25f4168
Fix links
yvonnefroehlich Jul 26, 2026
e321bdf
Shorten formulation
yvonnefroehlich Jul 26, 2026
66def28
Try cards and bottoms for specific topics
yvonnefroehlich Jul 26, 2026
a4b8d7d
Polish cards
yvonnefroehlich Jul 26, 2026
adf8900
Polish cards
yvonnefroehlich Jul 26, 2026
55c197f
Polish cards
yvonnefroehlich Jul 26, 2026
e396a6c
Improve icons
yvonnefroehlich Jul 26, 2026
6ca196d
Improve icons
yvonnefroehlich Jul 26, 2026
683b8db
Polish cards
yvonnefroehlich Jul 26, 2026
d3f5178
Remove question mark
yvonnefroehlich Jul 26, 2026
09c4b1e
Increase size of icons
yvonnefroehlich Jul 26, 2026
405b82d
Fix typo
yvonnefroehlich Jul 26, 2026
f935948
Fix links for buttons
yvonnefroehlich Jul 26, 2026
dfc9bf4
Add links to cards
yvonnefroehlich Jul 26, 2026
ed68a57
Fix typos and improve formulations
yvonnefroehlich Jul 26, 2026
3efbd6f
Improve formulation
yvonnefroehlich Jul 26, 2026
737f0f3
Add comments to explain landiing page setup
yvonnefroehlich Jul 26, 2026
f3fa221
Move comment
yvonnefroehlich Jul 26, 2026
ffce07a
Merge branch 'main' into create-website-cards
yvonnefroehlich Jul 27, 2026
4026518
Fix typo
yvonnefroehlich Jul 27, 2026
fed5cd9
Rename from 'Conference presentations' to ' Presentations'
yvonnefroehlich Jul 27, 2026
f6f5158
Move comment out of 'grid' to avoid sphinx warning
yvonnefroehlich Jul 27, 2026
f9afea7
Merge branch 'main' into create-website-cards
yvonnefroehlich Jul 28, 2026
aefa35d
Move minversions and changelog back to Technical Reference
yvonnefroehlich Jul 29, 2026
6019b68
Merge branch 'main' into create-website-cards
yvonnefroehlich Jul 29, 2026
0a9ec49
Merge branch 'main' into create-website-cards
yvonnefroehlich Jul 30, 2026
984c017
Use updated externa_resources file
yvonnefroehlich Aug 3, 2026
8b5da50
Use updated citing file
yvonnefroehlich Aug 3, 2026
8a3ffe1
Update overview
yvonnefroehlich Aug 3, 2026
b0907b2
Update README
yvonnefroehlich Aug 3, 2026
8b933f9
Update index
yvonnefroehlich Aug 3, 2026
52da23a
Add card-button layout for landing page
yvonnefroehlich Aug 3, 2026
60704ea
Merge branch 'main' into create-website-cards
yvonnefroehlich Aug 3, 2026
5b01e17
Remove line break between icon and heading
yvonnefroehlich Aug 6, 2026
d003db9
Rename 'Reference Documentation' to 'Reference Guide'
yvonnefroehlich Aug 6, 2026
81ab7c1
Reduce size of icon slightly
yvonnefroehlich Aug 6, 2026
5ab9ba5
Remove other card concepts
yvonnefroehlich Aug 6, 2026
694bf7c
Decrease space between buttons
yvonnefroehlich Aug 6, 2026
344d654
Exclude changes in README
yvonnefroehlich Aug 6, 2026
a838a2b
Exclude changes in overview
yvonnefroehlich Aug 6, 2026
3096030
Improve comment
yvonnefroehlich Aug 6, 2026
e43c106
Add link to GMT website not GitHub repo
yvonnefroehlich Aug 6, 2026
9560350
Make directives consistent
yvonnefroehlich Aug 6, 2026
9c65825
Adjust cards arragement based on screen size
yvonnefroehlich Aug 6, 2026
82a8aa2
Remove changes in conf.py
yvonnefroehlich Aug 6, 2026
6d2f8bd
Use two hypens for comments
yvonnefroehlich Aug 6, 2026
f77dc0f
Remove blank line
yvonnefroehlich Aug 6, 2026
20a8e29
Adjust buttons in 'Getting Help' section
yvonnefroehlich Aug 6, 2026
b579f0e
Merge branch 'main' into create-website-cards
yvonnefroehlich Aug 6, 2026
3da30cb
Change back to 'GMT Forum'
yvonnefroehlich Aug 6, 2026
2118da9
Merge branch 'main' into create-website-cards
yvonnefroehlich Aug 6, 2026
c69231a
Úse file name without file ending for button links
yvonnefroehlich Aug 6, 2026
eab8c10
Add comment
yvonnefroehlich Aug 6, 2026
c1e9a2f
Use page titles for buttons text
yvonnefroehlich Aug 6, 2026
148b2ca
Add comment
yvonnefroehlich Aug 6, 2026
880236d
Move comment
yvonnefroehlich Aug 6, 2026
6ca7918
Combine comments
yvonnefroehlich Aug 6, 2026
9b8e969
Make directives consistent for buttons
yvonnefroehlich Aug 6, 2026
1264c52
Remove css style for banner
yvonnefroehlich Aug 6, 2026
611162d
Remove button text
yvonnefroehlich Aug 6, 2026
893052d
Remove more '../' form links
yvonnefroehlich Aug 6, 2026
7381d73
Make sidebar and buttons order idenical
yvonnefroehlich Aug 6, 2026
686c53d
Move Tutorials befor Gallery
yvonnefroehlich Aug 7, 2026
bc60848
Add missing button for 'PyGMT Team'
yvonnefroehlich Aug 7, 2026
7b9a922
Move 'PyGMT Team' at the top
yvonnefroehlich Aug 7, 2026
038b8ec
Move 'Changes' after 'Min sup versions'
yvonnefroehlich Aug 7, 2026
5493465
Link to issues on GitHub
yvonnefroehlich Aug 7, 2026
d50d607
Improve icons
yvonnefroehlich Aug 7, 2026
bf04075
Remove comments to explain sphinx design RTD synthax
yvonnefroehlich Aug 7, 2026
eec4251
Revert "Move 'PyGMT Team' at the top"
yvonnefroehlich Aug 7, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 13 additions & 10 deletions doc/_static/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -38,16 +38,6 @@ p {
margin-bottom: 0px;
}

.banner {
padding-bottom: 60px;
text-align: center;
}

.banner h1 {
margin-top: 40px;
font-size: 4em;
}

.wy-nav-content {
max-width: 1000px;
}
Expand All @@ -71,6 +61,19 @@ 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 */
}

/* Set margin below buttons */
.sd-card-text {
margin-bottom: 10px;
}

/* Format parameters section similar to sphinx_rtd_theme v4.x.x (not a grid) */
html.writer-html5 .rst-content dl.field-list {
display: initial;
Expand Down
4 changes: 2 additions & 2 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -215,11 +215,11 @@
"https://forum.generic-mapping-tools.org",
),
(
'<i class="fa fa-github fa-fw"></i> Bug Report (GitHub)',
'<i class="fa fa-bug fa-fw"></i> Bug Report (GitHub)',
f"{repository_url}/issues",
),
(
'<i class="fa fa-gavel fa-fw"></i> Code of Conduct',
'<i class="fa fa-handshake-o fa-fw"></i> Code of Conduct',
"https://github.com/GenericMappingTools/.github/blob/main/CODE_OF_CONDUCT.md",
),
],
Expand Down
189 changes: 171 additions & 18 deletions doc/index.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,172 @@
```{title} Home
```
:::{title} Home
:::

<div class="banner">
Comment thread
yvonnefroehlich marked this conversation as resolved.
<img src="_static/pygmtlogo.png" alt="PyGMT Logo" style="width: 65%;">
<h2>
A Python interface for the
<a href="https://www.generic-mapping-tools.org/">Generic Mapping Tools</a>
</h2>
</div>

```{include} ../README.md
:start-after: <!-- doc-index-start-after -->
:end-before: <!-- doc-index-end-before -->
:relative-images:
```
<!-- Reference: https://sphinx-design.readthedocs.io/en/rtd-theme/index.html -->
<!-- Add and center the PyGMT logo image -->
::::{div} sd-d-flex-row sd-align-major-center
:::{image} ./_static/pygmtlogo.png
:width: 600px
:::
::::
<!-- Add short text what PyGMT is and does -->
:::{div} sd-text-center sd-fs-3 sd-pt-3 sd-pb-3
A Python interface for the [Generic Mapping Tools](https://www.generic-mapping-tools.org/)
:::

:::{div} sd-text-center sd-fs-5 sd-pb-3
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://www.generic-mapping-tools.org/), a command-line
program widely used across the Earth, Ocean, and Planetary sciences and beyond.
:::


<!-- Set up grid -->
:::::{grid} 1 2 2 3

::::{grid-item-card}
:margin: 0 3 0 0
{octicon}`rocket;2.5em;sd-text-info` **Getting Started**
^^^
:::{button-ref} install
:color: secondary
:outline:
:shadow:
:::
:::{button-ref} intro/index
:color: secondary
:outline:
:shadow:
:::
::::

::::{grid-item-card}
:margin: 0 3 0 0
{octicon}`globe;2.5em;sd-text-info` **Project Overview**
^^^
:::{button-ref} overview
:color: secondary
:outline:
:shadow:
:::
:::{button-ref} ecosystem
:color: secondary
:outline:
:shadow:
:::
:::{button-ref} presentations
:color: secondary
:outline:
:shadow:
:::
:::{button-ref} citing
:color: secondary
:outline:
:shadow:
:::
::::

::::{grid-item-card}
:margin: 0 3 0 0
{octicon}`mortar-board;2.5em;sd-text-info` **User Guide**
^^^
:::{button-ref} tutorials/index
:color: secondary
:outline:
:shadow:
:::
:::{button-ref} gallery/index
:color: secondary
:outline:
:shadow:
:::
:::{button-ref} projections/index
:color: secondary
:outline:
:shadow:
:::
:::{button-ref} external_resources
:color: secondary
:outline:
:shadow:
:::
::::

::::{grid-item-card}
:margin: 0 3 0 0
{octicon}`book;2.5em;sd-text-info` **Reference Guide**
^^^
:::{button-ref} api/index
:color: secondary
:outline:
:shadow:
:::
:::{button-ref} techref/index
:color: secondary
:outline:
:shadow:
:::
:::{button-ref} minversions
:color: secondary
:outline:
:shadow:
:::
:::{button-ref} changes
:color: secondary
:outline:
:shadow:
:::
::::

::::{grid-item-card}
:margin: 0 3 0 0
{octicon}`terminal;2.5em;sd-text-info` **Development**
^^^
Comment thread
yvonnefroehlich marked this conversation as resolved.
:::{button-ref} contributing
:color: secondary
:outline:
:shadow:
:::
:::{button-ref} maintenance
:color: secondary
:outline:
:shadow:
:::
:::{button-ref} team
:color: secondary
:outline:
:shadow:
:::
::::

::::{grid-item-card}
:margin: 0 3 0 0
{octicon}`light-bulb;2.5em;sd-text-info` **Getting Help**
^^^
:::{button-link} https://forum.generic-mapping-tools.org
:color: secondary
:outline:
:shadow:
{octicon}`comment-discussion;1em;sd-text-info` GMT Forum
:::
:::{button-link} https://github.com/GenericMappingTools/pygmt/issues
:color: secondary
:outline:
:shadow:
{octicon}`bug;1em;sd-text-info` Bug Report (GitHub)
:::
:::{button-link} https://github.com/GenericMappingTools/.github/blob/main/CODE_OF_CONDUCT.md
:color: secondary
:outline:
:shadow:
{octicon}`code-of-conduct;1em;sd-text-info` Code of Conduct
:::
::::

:::::


<!-- Set up sidebar -->

```{toctree}
:maxdepth: 2
Expand Down Expand Up @@ -49,20 +202,20 @@ external_resources.md
```{toctree}
:maxdepth: 2
:hidden:
:caption: Reference Documentation
:caption: Reference Guide

api/index.rst
techref/index.md
changes.md
minversions.md
changes.md
```

```{toctree}
:maxdepth: 2
:hidden:
:caption: Development

team.md
contributing.md
maintenance.md
team.md
```
Loading