Updates from the package template (#171)

* Automatic package template update * Update pyproject.toml * [pre-commit.ci lite] apply automatic fixes --------- Co-authored-by: Cadair <[email protected]> Co-authored-by: Stuart Mumford <[email protected]> Co-authored-by: pre-commit-ci-lite[bot] <117423508+pre-commit-ci-lite[bot]@users.noreply.github.com>
sunpy · Sep 30, 2024 · b79ab48 · b79ab48
1 parent 4f9dedb
commit b79ab48
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 12 deletions.
diff --git a/.cruft.json b/.cruft.json
@@ -1,6 +1,6 @@
 {
   "template": "https://github.com/sunpy/package-template",
-  "commit": "147c523135c0c612de0054897c87f8b4454dcd7a",
+  "commit": "17602ec8f8d4a4c5722bca00e255e480683f5096",
   "checkout": null,
   "context": {
     "cookiecutter": {

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,7 +1,7 @@
 repos:
     # This should be before any formatting hooks like isort
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.6.4"
+    rev: "v0.6.7"
     hooks:
       - id: ruff
         args: ["--fix"]

diff --git a/docs/conf.py b/docs/conf.py
@@ -6,12 +6,22 @@
 
 import datetime
 
+from packaging.version import Version
+
 # -- Project information -----------------------------------------------------
 
 # The full version, including alpha/beta/rc tags
 from streamtracer import __version__
 
-release = __version__
+_version = Version(__version__)
+version = release = str(_version)
+# Avoid "post" appearing in version string in rendered docs
+if _version.is_postrelease:
+    version = release = _version.base_version
+# Avoid long githashes in rendered Sphinx docs
+elif _version.is_devrelease:
+    version = release = f"{_version.base_version}.dev{_version.dev}"
+is_development = _version.is_devrelease
 
 project = "streamtracer"
 author = "The SunPy Developers, David Stansby"

diff --git a/pyproject.toml b/pyproject.toml
@@ -4,10 +4,6 @@ requires = [
 ]
 build-backend = "maturin"
 
-[tool.maturin]
-python-source = "python"
-module-name = "streamtracer._streamtracer_rust"
-
 [project]
 name = "streamtracer"
 description = "Python library to calculate streamlines"
@@ -38,11 +34,6 @@ dependencies = [
   "packaging>=21.3",
 ]
 
-[project.urls]
-Homepage = "https://docs.sunpy.org/projects/streamtracer"
-Documentation = "https://docs.sunpy.org/projects/streamtracer"
-Repository = "https://github.com/sunpy/streamtracer"
-
 [project.optional-dependencies]
 tests = [
   "pytest",
@@ -53,11 +44,21 @@ tests = [
 docs = [
   "sphinx",
   "sphinx-automodapi",
+  "packaging",
   "jupyter-sphinx",
   "sunpy-sphinx-theme",
   "sphinx-changelog",
 ]
 
+[project.urls]
+Homepage = "https://docs.sunpy.org/projects/streamtracer"
+Documentation = "https://docs.sunpy.org/projects/streamtracer"
+Repository = "https://github.com/sunpy/streamtracer"
+
+[tool.maturin]
+python-source = "python"
+module-name = "streamtracer._streamtracer_rust"
+
 [tool.cibuildwheel]
 before-build = "rustup show"
 environment = {"PATH" = "$PATH:$HOME/.cargo/bin"}