From nobody Thu Aug 31 05:47:49 2023 X-Original-To: dev-commits-ports-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4RbqvB4cJpz4rlc9; Thu, 31 Aug 2023 05:47:50 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4RbqvB0gtQz4Hxl; Thu, 31 Aug 2023 05:47:50 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1693460870; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=XbOi3htGD9UDLNvVjSqcSq2G+FYv54npZjZwJ5sYZ4I=; b=IqO0oHDsAza+M4QxNXlYtO2ZLKslAdkui11n0J/XPGvUqgvK/QODRjjpnoxvQjbka5rbaO dw6ZVmFqB6/+qhq36kSZZr/41oCbQM+QGPYHUFdjCiMIW40HgCljnmGWfT/lhBI9+BPejq g9my9wPwNOhp4e9jaoJeX2ewDb1js3C9QR6Oi/XiWmpNkdw5ax8t19Pon7SUWYftgS8dJD v0MjfTcQEKZhWNsGzaxOSkH9TEROc/7OXM8lsHI7SU3XEeW54XWfKIGiFPscvTSicmDZVu f4idTz8ECQGNilU1iF42kOQZoMSBEfSzsOPldZ3jy3dEUHacZb3A6OHk3Oq5Rg== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1693460870; a=rsa-sha256; cv=none; b=JsCadIZPlfETRY4cL3+RptLE1c6BHpH8Yb+6FSZpFHcQ7q75DKT+eToIY1HlYQsJG1oQF1 o79GDj3FmXh9aDNQ0a89q5btzaZNtBKW43u2ryP/EgAVytwe3BmA7n4g49IitKll3OUBGt CewH2EebChcaIF0vDTpnceAPH7rj7KebVFDogLFLrtP/d8YNQx6zXW5oqMhokEBiRbaA+m WoxaAqCbBmnpsk+E/3joPBpd9LZgE9/3KkpY0+2VFo/+X1hJXjGuRP49hRlnLefaQlyLbJ RfI94LuiDWubX515lwGx19eWIfTsedSAphla1YpyPmF9TcQPeAE+3IPxnk3GKA== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1693460870; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=XbOi3htGD9UDLNvVjSqcSq2G+FYv54npZjZwJ5sYZ4I=; b=VfXnvlT+tJWeR6Gpai6pkjmiL+xgxCCNrOgV2Rj3U0j3fQDK4u9gtPEHHJBhFR/EuMKl9V /We/ruMM9hiSW54C5EK8zkCK6TH5Q7AZ15vCvBk3gxXlTuQCAw02Y3LOAjLO0WVY8bCINA b/Dnx86qAFUKoK7zOhV/wC8y/Ag/bDfQbQ4YRqRZeT6fIZb/uvsg+UvelU0J6/04NSj6et FjbP1Mi5j9prTml4Me9A1NV+CTgYapcr3rmQ5TBG95BN0ok/kwTOKO99lYS8JLCJt/UNbN u/LATOUU10Ja97d3JqtpFPyzt0weerelkM3CHvixfjxDPcFohmee1Dn+quFRVw== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 4Rbqv96vBlz14k0; Thu, 31 Aug 2023 05:47:49 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.17.1/8.17.1) with ESMTP id 37V5lnGl068341; Thu, 31 Aug 2023 05:47:49 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.17.1/8.17.1/Submit) id 37V5lneJ068338; Thu, 31 Aug 2023 05:47:49 GMT (envelope-from git) Date: Thu, 31 Aug 2023 05:47:49 GMT Message-Id: <202308310547.37V5lneJ068338@gitrepo.freebsd.org> To: ports-committers@FreeBSD.org, dev-commits-ports-all@FreeBSD.org, dev-commits-ports-main@FreeBSD.org From: Kai Knoblich Subject: git: e1c6e80783e1 - main - textproc/py-mkdocstrings-python-legacy: New port List-Id: Commit messages for all branches of the ports repository List-Archive: https://lists.freebsd.org/archives/dev-commits-ports-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-ports-all@freebsd.org X-BeenThere: dev-commits-ports-all@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: kai X-Git-Repository: ports X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: e1c6e80783e10e0716b5cab7b1b0448d5f48f7ca Auto-Submitted: auto-generated The branch main has been updated by kai: URL: https://cgit.FreeBSD.org/ports/commit/?id=e1c6e80783e10e0716b5cab7b1b0448d5f48f7ca commit e1c6e80783e10e0716b5cab7b1b0448d5f48f7ca Author: Kai Knoblich AuthorDate: 2023-08-31 05:25:26 +0000 Commit: Kai Knoblich CommitDate: 2023-08-31 05:44:11 +0000 textproc/py-mkdocstrings-python-legacy: New port This Python handler for the "mkdocstrings" package uses PyTkDocs (= textproc/py-pytkdocs) to collect documentation from Python source code. Features: * Data collection from source code: collection of the object-tree and the docstrings is done thanks to pytkdocs. * Support for type annotations: pytkdocs collects your type annotations and mkdocstrings uses them to display parameters types or return types. * Recursive documentation of Python objects: just use the module dotted-path as identifier, and you get the full module docs. You don't need to inject documentation for each class, function, etc. * Support for documented attributes: attributes (variables) followed by a docstring (triple-quoted string) will be recognized by Griffe in modules, classes and even in __init__ methods. * Multiple docstring-styles support: common support for Google-style, Numpydoc-style, and Sphinx-style docstrings. --- textproc/Makefile | 1 + textproc/py-mkdocstrings-python-legacy/Makefile | 31 ++++++++++++++++++++++ textproc/py-mkdocstrings-python-legacy/distinfo | 3 +++ .../files/patch-pyproject.toml | 23 ++++++++++++++++ textproc/py-mkdocstrings-python-legacy/pkg-descr | 21 +++++++++++++++ 5 files changed, 79 insertions(+) diff --git a/textproc/Makefile b/textproc/Makefile index e9ee6ca2a756..b9bc40227ec9 100644 --- a/textproc/Makefile +++ b/textproc/Makefile @@ -1439,6 +1439,7 @@ SUBDIR += py-mkdocstrings SUBDIR += py-mkdocstrings-crystal SUBDIR += py-mkdocstrings-python + SUBDIR += py-mkdocstrings-python-legacy SUBDIR += py-morse3 SUBDIR += py-mwparserfromhell SUBDIR += py-myst-parser diff --git a/textproc/py-mkdocstrings-python-legacy/Makefile b/textproc/py-mkdocstrings-python-legacy/Makefile new file mode 100644 index 000000000000..c6ceaa599bea --- /dev/null +++ b/textproc/py-mkdocstrings-python-legacy/Makefile @@ -0,0 +1,31 @@ +PORTNAME= mkdocstrings-python-legacy +DISTVERSION= 0.2.3 +CATEGORIES= textproc python +MASTER_SITES= PYPI +PKGNAMEPREFIX= ${PYTHON_PKGNAMEPREFIX} + +MAINTAINER= kai@FreeBSD.org +COMMENT= Legacy Python handler for mkdocstrings +WWW= https://github.com/mkdocstrings/python-legacy + +LICENSE= ISCL +LICENSE_FILE= ${WRKSRC}/LICENSE + +BUILD_DEPENDS= ${PYTHON_PKGNAMEPREFIX}pdm-pep517>0:devel/py-pdm-pep517@${PY_FLAVOR} +RUN_DEPENDS= ${PYTHON_PKGNAMEPREFIX}pytkdocs>=0.14:textproc/py-pytkdocs@${PY_FLAVOR} +TEST_DEPENDS= ${PYTHON_PKGNAMEPREFIX}mkdocstrings>0:textproc/py-mkdocstrings@${PY_FLAVOR} +# textproc/py-mkdocstrings belongs to RUN_DEPENDS as well but would cause +# a circular dependency (via py-mkdocstrings' PYTHONLEGACY option). It was +# therefore # moved to TEST_DEPENDS to at least allow the test suite to run. + +USES= python +USE_PYTHON= autoplist pep517 pytest +PYTEST_IGNORED_TESTS= render_themes + +TEST_ENV= PYTHONPATH=${STAGEDIR}${PYTHONPREFIX_SITELIBDIR} + +CONFLICTS_INSTALL= ${PYTHON_PKGNAMEPREFIX}mkdocstrings-python + +NO_ARCH= yes + +.include diff --git a/textproc/py-mkdocstrings-python-legacy/distinfo b/textproc/py-mkdocstrings-python-legacy/distinfo new file mode 100644 index 000000000000..4cf7018cef74 --- /dev/null +++ b/textproc/py-mkdocstrings-python-legacy/distinfo @@ -0,0 +1,3 @@ +TIMESTAMP = 1688218792 +SHA256 (mkdocstrings-python-legacy-0.2.3.tar.gz) = 3fb58fdabe19c6b52b8bb1d3bb1540b1cd527b562865468d6754e8cd1201050c +SIZE (mkdocstrings-python-legacy-0.2.3.tar.gz) = 18779 diff --git a/textproc/py-mkdocstrings-python-legacy/files/patch-pyproject.toml b/textproc/py-mkdocstrings-python-legacy/files/patch-pyproject.toml new file mode 100644 index 000000000000..117ead8b89a1 --- /dev/null +++ b/textproc/py-mkdocstrings-python-legacy/files/patch-pyproject.toml @@ -0,0 +1,23 @@ +Workaround to prevent following error: + +[...] + File "/usr/local/lib/python3.9/site-packages/pdm/pep517/metadata.py", line 58, in validate + return validate_pep621(self.data, raising) + File "/usr/local/lib/python3.9/site-packages/pdm/pep517/validator.py", line 85, in validate_pep621 + raise PEP621ValidationError(validator.errors) +pdm.pep517.exceptions.PEP621ValidationError: {'license-expression': ['unknown field']} + +ERROR Backend subprocess exited when trying to invoke get_requires_for_build_wheel +*** Error code 1 +[...] + +--- pyproject.toml.orig 2022-05-28 13:34:29 UTC ++++ pyproject.toml +@@ -10,7 +10,6 @@ authors = [ + authors = [ + { name = "Timothée Mazzucotelli", email = "pawamoy@pm.me" }, + ] +-license-expression = "ISC" + readme = "README.md" + requires-python = ">=3.7" + keywords = [] diff --git a/textproc/py-mkdocstrings-python-legacy/pkg-descr b/textproc/py-mkdocstrings-python-legacy/pkg-descr new file mode 100644 index 000000000000..f02e2f73ebd8 --- /dev/null +++ b/textproc/py-mkdocstrings-python-legacy/pkg-descr @@ -0,0 +1,21 @@ +This Python handler for the "mkdocstrings" package uses PyTkDocs +(= textproc/py-pytkdocs) to collect documentation from Python source code. + +Features: + +* Data collection from source code: collection of the object-tree and the + docstrings is done thanks to pytkdocs. + +* Support for type annotations: pytkdocs collects your type annotations and + mkdocstrings uses them to display parameters types or return types. + +* Recursive documentation of Python objects: just use the module dotted-path as + identifier, and you get the full module docs. You don't need to inject + documentation for each class, function, etc. + +* Support for documented attributes: attributes (variables) followed by a + docstring (triple-quoted string) will be recognized by Griffe in modules, + classes and even in __init__ methods. + +* Multiple docstring-styles support: common support for Google-style, + Numpydoc-style, and Sphinx-style docstrings.