Merge branch 'fix/datetime' into to_numpy/datetime

Author: seisman

doc/Makefile

@@ -1,14 +1,12 @@
 # Makefile for Sphinx documentation
 
 # You can set these variables from the command line.
-SPHINXOPTS    = -j auto
-SPHINXBUILD   = sphinx-build
+SPHINXOPTS    ?= -j auto
+SPHINXBUILD   ?= sphinx-build
 SPHINXAUTOGEN = sphinx-autogen
+SOURCEDIR     = .
 BUILDDIR      = _build
 
-# Internal variables.
-ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees  $(SPHINXOPTS) .
-
 .PHONY: help all api html server clean
 
 help:
@@ -28,20 +26,20 @@ api:
 	@echo
 	$(SPHINXAUTOGEN) -i -t _templates -o api/generated api/*.rst
 
-html: api
+html latex: api
 	@echo
-	@echo "Building HTML files."
+	@echo "Building "$@" files."
 	@echo
 	# Set PYGMT_USE_EXTERNAL_DISPLAY to "false" to disable external display
-	PYGMT_USE_EXTERNAL_DISPLAY="false" $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	PYGMT_USE_EXTERNAL_DISPLAY="false" $(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS)
 	@echo
-	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+	@echo "Build finished. The files are in $(BUILDDIR)/$@."
 
 html-noplot: api
 	@echo
 	@echo "Building HTML files without example plots."
 	@echo
-	$(SPHINXBUILD) -D plot_gallery=0 -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) -D plot_gallery=0
 	@echo
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
 

doc/conf.py

@@ -210,12 +210,10 @@
 repository = "GenericMappingTools/pygmt"
 repository_url = "https://github.com/GenericMappingTools/pygmt"
 if __commit__:
-    commit_link = (
-        f'<a href="{repository_url}/commit/{ __commit__ }">{ __commit__[:8] }</a>'
-    )
+    commit_link = f'<a href="{repository_url}/commit/{__commit__}">{__commit__[:8]}</a>'
 else:
     commit_link = (
-        f'<a href="{repository_url}/releases/tag/{ __version__ }">{ __version__ }</a>'
+        f'<a href="{repository_url}/releases/tag/{__version__}">{__version__}</a>'
     )
 html_context = {
     "menu_links": [

environment.yml

@@ -27,7 +27,7 @@ dependencies:
     # Dev dependencies (style checks)
     - codespell
     - pre-commit
-    - ruff>=0.8.2
+    - ruff>=0.9.0
     # Dev dependencies (unit testing)
     - matplotlib-base
     - pytest>=6.0

examples/tutorials/advanced/cartesian_histograms.py

@@ -348,7 +348,7 @@
     # of the bin width
     # Offset ("+o") the bars to align each bar with the left limit of the corresponding
     # bin
-    barwidth=f"{binwidth/2}+o-{binwidth/4}",
+    barwidth=f"{binwidth / 2}+o-{binwidth / 4}",
     label="data01",
 )
 
@@ -359,7 +359,7 @@
     fill="orange",
     pen="1p,darkgray,solid",
     histtype=0,
-    barwidth=f"{binwidth/2}+o{binwidth/4}",
+    barwidth=f"{binwidth / 2}+o{binwidth / 4}",
     label="data02",
 )
 

pygmt/_show_versions.py

@@ -16,7 +16,7 @@
 from pygmt.clib import Session, __gmt_version__
 
 # Get semantic version through setuptools-scm
-__version__ = f'v{version("pygmt")}'  # e.g. v0.1.2.dev3+g0ab3cd78
+__version__ = f"v{version('pygmt')}"  # e.g. v0.1.2.dev3+g0ab3cd78
 __commit__ = __version__.split("+g")[-1] if "+g" in __version__ else ""  # 0ab3cd78
 
 

pygmt/encodings.py

@@ -1,3 +1,4 @@
+# noqa: A005
 """
 Character encodings supported by GMT.
 

pygmt/helpers/tempfile.py

@@ -1,3 +1,4 @@
+# noqa: A005
 """
 Utilities for dealing with temporary file management.
 """

pygmt/helpers/utils.py

@@ -574,9 +574,8 @@ def launch_external_viewer(fname: str, waiting: float = 0) -> None:
     }
 
     match sys.platform:
-        case name if (
-            (name == "linux" or name.startswith("freebsd"))
-            and (xdgopen := shutil.which("xdg-open"))
+        case name if (name == "linux" or name.startswith("freebsd")) and (
+            xdgopen := shutil.which("xdg-open")
         ):  # Linux/FreeBSD
             subprocess.run([xdgopen, fname], check=False, **run_args)  # type:ignore[call-overload]
         case "darwin":  # macOS

pygmt/io.py

@@ -1,3 +1,4 @@
+# noqa: A005
 """
 PyGMT input/output (I/O) utilities.
 """

pygmt/src/grd2xyz.py

@@ -145,8 +145,7 @@ def grd2xyz(
 
     if kwargs.get("o") is not None and output_type == "pandas":
         msg = (
-            "If 'outcols' is specified, 'output_type' must be either 'numpy' "
-            "or 'file'."
+            "If 'outcols' is specified, 'output_type' must be either 'numpy' or 'file'."
         )
         raise GMTInvalidInput(msg)
     # Set the default column names for the pandas DataFrame header.