From owner-svn-ports-all@freebsd.org Sat Nov 14 19:42:40 2020 Return-Path: Delivered-To: svn-ports-all@mailman.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.nyi.freebsd.org (Postfix) with ESMTP id ED5ED463FDA; Sat, 14 Nov 2020 19:42:40 +0000 (UTC) (envelope-from egypcio@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 "Let's Encrypt Authority X3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4CYQjD6LCHz3rxK; Sat, 14 Nov 2020 19:42:40 +0000 (UTC) (envelope-from egypcio@FreeBSD.org) Received: from repo.freebsd.org (repo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id CC6C77896; Sat, 14 Nov 2020 19:42:40 +0000 (UTC) (envelope-from egypcio@FreeBSD.org) Received: from repo.freebsd.org ([127.0.1.37]) by repo.freebsd.org (8.15.2/8.15.2) with ESMTP id 0AEJgeYm069249; Sat, 14 Nov 2020 19:42:40 GMT (envelope-from egypcio@FreeBSD.org) Received: (from egypcio@localhost) by repo.freebsd.org (8.15.2/8.15.2/Submit) id 0AEJge3r069246; Sat, 14 Nov 2020 19:42:40 GMT (envelope-from egypcio@FreeBSD.org) Message-Id: <202011141942.0AEJge3r069246@repo.freebsd.org> X-Authentication-Warning: repo.freebsd.org: egypcio set sender to egypcio@FreeBSD.org using -f From: =?UTF-8?Q?Vin=c3=adcius_Zavam?= Date: Sat, 14 Nov 2020 19:42:40 +0000 (UTC) To: ports-committers@freebsd.org, svn-ports-all@freebsd.org, svn-ports-head@freebsd.org Subject: svn commit: r555141 - in head/textproc: . py-collective.checkdocs X-SVN-Group: ports-head X-SVN-Commit-Author: egypcio X-SVN-Commit-Paths: in head/textproc: . py-collective.checkdocs X-SVN-Commit-Revision: 555141 X-SVN-Commit-Repository: ports MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-ports-all@freebsd.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: SVN commit messages for the ports tree List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sat, 14 Nov 2020 19:42:41 -0000 Author: egypcio Date: Sat Nov 14 19:42:39 2020 New Revision: 555141 URL: https://svnweb.freebsd.org/changeset/ports/555141 Log: [NEW] textproc/py-collective.checkdocs: view and validate w/ long_description collective.checkdocs adds new distutils commands checkdocs and showdocs to validate restructured text in long_description field of Python eggs. This package aims to make Python egg help page publishing and editing easier. Eggs' long description field, which is usually also the README.txt file of the package, is reST formatted text. This text is converted to HTML to show on the package page when package is published in distribution repositories like PyPI or plone.org. Unfortunately, since repositories do poor job to validate incoming reST text, errors in the text will result to broken published package pages. Unpublishing is usually very cumbersome. We save our time by validating reST input using checkdocs and showdocs commands before submitting eggs to PyPi. WWW: https://github.com/collective/collective.checkdocs Added: head/textproc/py-collective.checkdocs/ head/textproc/py-collective.checkdocs/Makefile (contents, props changed) head/textproc/py-collective.checkdocs/distinfo (contents, props changed) head/textproc/py-collective.checkdocs/pkg-descr (contents, props changed) Modified: head/textproc/Makefile Modified: head/textproc/Makefile ============================================================================== --- head/textproc/Makefile Sat Nov 14 19:42:17 2020 (r555140) +++ head/textproc/Makefile Sat Nov 14 19:42:39 2020 (r555141) @@ -1242,6 +1242,7 @@ SUBDIR += py-cjkwrap SUBDIR += py-cloud_sptheme SUBDIR += py-cmarkgfm + SUBDIR += py-collective.checkdocs SUBDIR += py-colorclass SUBDIR += py-creole SUBDIR += py-cssselect2 Added: head/textproc/py-collective.checkdocs/Makefile ============================================================================== --- /dev/null 00:00:00 1970 (empty, because file is newly added) +++ head/textproc/py-collective.checkdocs/Makefile Sat Nov 14 19:42:39 2020 (r555141) @@ -0,0 +1,21 @@ +# $FreeBSD$ + +PORTNAME= collective.checkdocs +PORTVERSION= 0.2 +CATEGORIES= textproc devel python +MASTER_SITES= CHEESESHOP +PKGNAMEPREFIX= ${PYTHON_PKGNAMEPREFIX} + +MAINTAINER= egypcio@FreeBSD.org +COMMENT= View and validate restructured text in package's long_description + +LICENSE= GPLv2 + +RUN_DEPENDS= ${PYTHON_PKGNAMEPREFIX}docutils>=0.15:textproc/py-docutils@${PY_FLAVOR} + +USES= python zip +USE_PYTHON= autoplist concurrent distutils + +NO_ARCH= yes + +.include Added: head/textproc/py-collective.checkdocs/distinfo ============================================================================== --- /dev/null 00:00:00 1970 (empty, because file is newly added) +++ head/textproc/py-collective.checkdocs/distinfo Sat Nov 14 19:42:39 2020 (r555141) @@ -0,0 +1,3 @@ +TIMESTAMP = 1605029614 +SHA256 (collective.checkdocs-0.2.zip) = 3a5328257c5224bc72753820c182910d7fb336bc1dba5e09113d48566655e46e +SIZE (collective.checkdocs-0.2.zip) = 10865 Added: head/textproc/py-collective.checkdocs/pkg-descr ============================================================================== --- /dev/null 00:00:00 1970 (empty, because file is newly added) +++ head/textproc/py-collective.checkdocs/pkg-descr Sat Nov 14 19:42:39 2020 (r555141) @@ -0,0 +1,15 @@ +collective.checkdocs adds new distutils commands checkdocs and showdocs to +validate restructured text in long_description field of Python eggs. This +package aims to make Python egg help page publishing and editing easier. + +Eggs' long description field, which is usually also the README.txt file of +the package, is reST formatted text. This text is converted to HTML to show on +the package page when package is published in distribution repositories like +PyPI or plone.org. Unfortunately, since repositories do poor job to validate +incoming reST text, errors in the text will result to broken published +package pages. + +Unpublishing is usually very cumbersome. We save our time by validating reST +input using checkdocs and showdocs commands before submitting eggs to PyPi. + +WWW: https://github.com/collective/collective.checkdocs