GNU bug report logs - #68631
[PATCH] gnu: Add python-sphinx-issues.

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 68631 in the body.
You can then email your comments to 68631 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Troy Figiel <troy <at> troyfigiel.com>
To: guix-patches <at> gnu.org
Subject: [PATCH] gnu: Add python-sphinx-issues.
Date: Sun, 21 Jan 2024 11:11:41 +0100

* gnu/packages/sphinx.scm (python-sphinx-issues): New variable.
---
 gnu/packages/sphinx.scm | 43 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)

diff --git a/gnu/packages/sphinx.scm b/gnu/packages/sphinx.scm
index 7e5a929241..64c97afd8e 100644
--- a/gnu/packages/sphinx.scm
+++ b/gnu/packages/sphinx.scm
@@ -18,6 +18,7 @@
 ;;; Copyright © 2021, 2022 Vinicius Monego <monego <at> posteo.net>
 ;;; Copyright © 2021 Hugo Lecomte <hugo.lecomte <at> inria.fr>
 ;;; Copyright © 2021, 2022 Maxim Cournoyer <maxim.cournoyer <at> gmail.com>
+;;; Copyright © 2024 Troy Figiel <troy <at> troyfigiel.com>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -372,6 +373,48 @@ (define-public python-sphinxcontrib-newsfeed
     (home-page "https://bitbucket.org/prometheus/sphinxcontrib-newsfeed")
     (license license:bsd-2)))
 
+(define-public python-sphinx-issues
+  (package
+    (name "python-sphinx-issues")
+    (version "4.0.0")
+    (source
+     (origin
+       ;; No tests in the PyPI tarball.
+       (method git-fetch)
+       (uri (git-reference
+             (url "https://github.com/sloria/sphinx-issues")
+             (commit version)))
+       (file-name (git-file-name name version))
+       (sha256
+        (base32 "0q4as8gibvin0n6h5y1q4cwz3b1nwgs0idfc94dbndx42pjiz1vn"))))
+    (build-system pyproject-build-system)
+    (arguments
+     (list
+      #:phases #~(modify-phases %standard-phases
+                   (add-before 'check 'patch-sphinx-build-path
+                     (lambda _
+                       ;; The path to the sphinx-build binary is hardcoded to
+                       ;; be in the same directory as the python
+                       ;; executable. That does not work when building the
+                       ;; package.
+                       (substitute* "tests/test_sphinx_issues.py"
+                         (((string-append "Path\\(sys\\.executable\\)"
+                                          "\\.parent\\.joinpath\\"
+                                          "(\"sphinx-build\"\\)"))
+                          (string-append "\""
+                                         #$(this-package-native-input
+                                            "python-sphinx")
+                                         "/bin/sphinx-build\""))))))))
+    (native-inputs (list python-flit-core python-pytest python-sphinx))
+    (home-page "https://github.com/sloria/sphinx-issues")
+    (synopsis "Sphinx extension for linking to your project's issue tracker")
+    (description
+     "This package provides a Sphinx extension for linking to your project's
+issue tracker.  This includes roles for linking to issues, pull requests and
+user profiles.  Support for GitHub is built-in, but other services can also be
+supported with @code{sphinx-issues}.")
+    (license license:expat)))
+
 (define-public python-sphinx-panels
   (package
     (name "python-sphinx-panels")

base-commit: c79ffe25e98607d6803f960d5187e4098e1dc7c2
-- 
2.42.0

Message #8 received at 68631 <at> debbugs.gnu.org (full text, mbox):

From: Sharlatan Hellseher <sharlatanus <at> gmail.com>
To: 68631 <at> debbugs.gnu.org
Cc: Troy Figiel <troy <at> troyfigiel.com>
Subject: [PATCH] gnu: Add python-sphinx-issues.
Date: Thu, 25 Jan 2024 20:21:10 +0000

[Message part 1 (text/plain, inline)]

Hi,

Thank you for the patch.

It looks good.

> +    (synopsis "Sphinx extension for linking to your project's issue
tracker")

Just one neat pick to synopsis, drop "your": "Sphinx extension for linking
to project's issue tracker"

Nix has 1:1 the same synopsis as on project's GitHub page.
Debian has "your" silent.

Thanks,
Oleg

[Message part 2 (text/html, inline)]

Message #11 received at 68631 <at> debbugs.gnu.org (full text, mbox):

From: Troy Figiel <troy <at> troyfigiel.com>
To: 68631 <at> debbugs.gnu.org
Cc: Sharlatan Hellseher <sharlatanus <at> gmail.com>
Subject: Re: [PATCH] gnu: Add python-sphinx-issues.
Date: Thu, 25 Jan 2024 21:32:50 +0100

[Message part 1 (text/plain, inline)]

Hi Oleg,

I don't mind dropping "your", but grammatically we would need some
article. Something like "Sphinx extension for linking to a project's
issue tracker"? I checked the Debian synopsis and it's grammatically
incorrect, which reads a bit clunky.

Best wishes,

Troy

[OpenPGP_0xC67C9181B3893FB0.asc (application/pgp-keys, attachment)]

[OpenPGP_signature.asc (application/pgp-signature, attachment)]

Message #14 received at 68631 <at> debbugs.gnu.org (full text, mbox):

From: Troy Figiel <troy <at> troyfigiel.com>
To: 68631 <at> debbugs.gnu.org
Subject: [PATCH v2] gnu: Add python-sphinx-issues.
Date: Sun, 21 Jan 2024 11:11:41 +0100

* gnu/packages/sphinx.scm (python-sphinx-issues): New variable.
---
 gnu/packages/sphinx.scm | 43 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)

diff --git a/gnu/packages/sphinx.scm b/gnu/packages/sphinx.scm
index 7e5a929241..c34d72f7ca 100644
--- a/gnu/packages/sphinx.scm
+++ b/gnu/packages/sphinx.scm
@@ -18,6 +18,7 @@
 ;;; Copyright © 2021, 2022 Vinicius Monego <monego <at> posteo.net>
 ;;; Copyright © 2021 Hugo Lecomte <hugo.lecomte <at> inria.fr>
 ;;; Copyright © 2021, 2022 Maxim Cournoyer <maxim.cournoyer <at> gmail.com>
+;;; Copyright © 2024 Troy Figiel <troy <at> troyfigiel.com>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -372,6 +373,48 @@ (define-public python-sphinxcontrib-newsfeed
     (home-page "https://bitbucket.org/prometheus/sphinxcontrib-newsfeed")
     (license license:bsd-2)))
 
+(define-public python-sphinx-issues
+  (package
+    (name "python-sphinx-issues")
+    (version "4.0.0")
+    (source
+     (origin
+       ;; No tests in the PyPI tarball.
+       (method git-fetch)
+       (uri (git-reference
+             (url "https://github.com/sloria/sphinx-issues")
+             (commit version)))
+       (file-name (git-file-name name version))
+       (sha256
+        (base32 "0q4as8gibvin0n6h5y1q4cwz3b1nwgs0idfc94dbndx42pjiz1vn"))))
+    (build-system pyproject-build-system)
+    (arguments
+     (list
+      #:phases #~(modify-phases %standard-phases
+                   (add-before 'check 'patch-sphinx-build-path
+                     (lambda _
+                       ;; The path to the sphinx-build binary is hardcoded to
+                       ;; be in the same directory as the python
+                       ;; executable. That does not work when building the
+                       ;; package.
+                       (substitute* "tests/test_sphinx_issues.py"
+                         (((string-append "Path\\(sys\\.executable\\)"
+                                          "\\.parent\\.joinpath\\"
+                                          "(\"sphinx-build\"\\)"))
+                          (string-append "\""
+                                         #$(this-package-native-input
+                                            "python-sphinx")
+                                         "/bin/sphinx-build\""))))))))
+    (native-inputs (list python-flit-core python-pytest python-sphinx))
+    (home-page "https://github.com/sloria/sphinx-issues")
+    (synopsis "Sphinx extension for linking to a project's issue tracker")
+    (description
+     "This package provides a Sphinx extension for linking to your project's
+issue tracker.  This includes roles for linking to issues, pull requests and
+user profiles.  Support for GitHub is built-in, but other services can also be
+supported with @code{sphinx-issues}.")
+    (license license:expat)))
+
 (define-public python-sphinx-panels
   (package
     (name "python-sphinx-panels")

base-commit: 9b657bab84be02935d66483da1ebbe4bc78c52fb
-- 
2.42.0

Message #17 received at 68631 <at> debbugs.gnu.org (full text, mbox):

From: Troy Figiel <troy <at> troyfigiel.com>
To: 68631 <at> debbugs.gnu.org
Subject: Re: [bug#68631] [PATCH v2] gnu: Add python-sphinx-issues.
Date: Thu, 25 Jan 2024 23:49:00 +0100

Hi Oleg,

- Rebased on master
- "your" -> "a" in the synopsis

Thanks for the review!

Best wishes,

Troy

Message #20 received at 68631 <at> debbugs.gnu.org (full text, mbox):

From: Troy Figiel <troy <at> troyfigiel.com>
To: 68631 <at> debbugs.gnu.org
Subject: Re: [bug#68631] [PATCH v2] gnu: Add python-sphinx-issues.
Date: Thu, 25 Jan 2024 23:54:18 +0100

On 2024-01-21 11:11, Troy Figiel wrote:
> +    (synopsis "Sphinx extension for linking to a project's issue tracker")
> +    (description
> +     "This package provides a Sphinx extension for linking to your project's
> +issue tracker.  This includes roles for linking to issues, pull requests and
> +user profiles.  Support for GitHub is built-in, but other services can also be
> +supported with @code{sphinx-issues}.")

Oof... description still has the "your project's issue tracker".
Smallest changes are the hardest. I will send you a v3 with that "your"
replaced by "a" as well.

Message #23 received at 68631 <at> debbugs.gnu.org (full text, mbox):

From: Troy Figiel <troy <at> troyfigiel.com>
To: 68631 <at> debbugs.gnu.org
Subject: [PATCH v3] gnu: Add python-sphinx-issues.
Date: Sun, 21 Jan 2024 11:11:41 +0100

* gnu/packages/sphinx.scm (python-sphinx-issues): New variable.
---
 gnu/packages/sphinx.scm | 43 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)

diff --git a/gnu/packages/sphinx.scm b/gnu/packages/sphinx.scm
index 7e5a929241..e280c06f2b 100644
--- a/gnu/packages/sphinx.scm
+++ b/gnu/packages/sphinx.scm
@@ -18,6 +18,7 @@
 ;;; Copyright © 2021, 2022 Vinicius Monego <monego <at> posteo.net>
 ;;; Copyright © 2021 Hugo Lecomte <hugo.lecomte <at> inria.fr>
 ;;; Copyright © 2021, 2022 Maxim Cournoyer <maxim.cournoyer <at> gmail.com>
+;;; Copyright © 2024 Troy Figiel <troy <at> troyfigiel.com>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -372,6 +373,48 @@ (define-public python-sphinxcontrib-newsfeed
     (home-page "https://bitbucket.org/prometheus/sphinxcontrib-newsfeed")
     (license license:bsd-2)))
 
+(define-public python-sphinx-issues
+  (package
+    (name "python-sphinx-issues")
+    (version "4.0.0")
+    (source
+     (origin
+       ;; No tests in the PyPI tarball.
+       (method git-fetch)
+       (uri (git-reference
+             (url "https://github.com/sloria/sphinx-issues")
+             (commit version)))
+       (file-name (git-file-name name version))
+       (sha256
+        (base32 "0q4as8gibvin0n6h5y1q4cwz3b1nwgs0idfc94dbndx42pjiz1vn"))))
+    (build-system pyproject-build-system)
+    (arguments
+     (list
+      #:phases #~(modify-phases %standard-phases
+                   (add-before 'check 'patch-sphinx-build-path
+                     (lambda _
+                       ;; The path to the sphinx-build binary is hardcoded to
+                       ;; be in the same directory as the python
+                       ;; executable. That does not work when building the
+                       ;; package.
+                       (substitute* "tests/test_sphinx_issues.py"
+                         (((string-append "Path\\(sys\\.executable\\)"
+                                          "\\.parent\\.joinpath\\"
+                                          "(\"sphinx-build\"\\)"))
+                          (string-append "\""
+                                         #$(this-package-native-input
+                                            "python-sphinx")
+                                         "/bin/sphinx-build\""))))))))
+    (native-inputs (list python-flit-core python-pytest python-sphinx))
+    (home-page "https://github.com/sloria/sphinx-issues")
+    (synopsis "Sphinx extension for linking to a project's issue tracker")
+    (description
+     "This package provides a Sphinx extension for linking to a project's
+issue tracker.  This includes roles for linking to issues, pull requests and
+user profiles.  Support for GitHub is built-in, but other services can also be
+supported with @code{sphinx-issues}.")
+    (license license:expat)))
+
 (define-public python-sphinx-panels
   (package
     (name "python-sphinx-panels")

base-commit: 9b657bab84be02935d66483da1ebbe4bc78c52fb
-- 
2.42.0

Message #28 received at 68631-done <at> debbugs.gnu.org (full text, mbox):

From: Sharlatan Hellseher <sharlatanus <at> gmail.com>
To: 68631-done <at> debbugs.gnu.org
Subject: [PATCH] gnu: Add python-sphinx-issues.
Date: Fri, 26 Jan 2024 22:16:32 +0000

[Message part 1 (text/plain, inline)]

Pushed as 0f646b0ec2b534c7338de5d402a928bc0b46611c to master.

Thanks,
Oleg

[signature.asc (application/pgp-signature, inline)]

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.