Port details |
- py-collective.checkdocs View and validate restructured text in package's long_description
- 0.2_1 textproc
=2 0.2Version of this port present on the latest quarterly branch. - Maintainer: egypcio@FreeBSD.org
 - Port Added: 2020-11-14 19:44:46
- Last Update: 2025-03-08 04:05:21
- Commit Hash: 06a08e6
- People watching this port, also watch:: jdictionary, py311-Automat, py311-python-gdsii, py311-PyOpenGL, p5-Sane
- Also Listed In: devel python
- License: GPLv2
- WWW:
- https://github.com/collective/collective.checkdocs
- 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.
¦ ¦ ¦ ¦ 
- Manual pages:
- FreshPorts has no man page information for this port.
- pkg-plist: as obtained via:
make generate-plist - There is no configure plist information for this port.
- Dependency lines:
-
- ${PYTHON_PKGNAMEPREFIX}collective.checkdocs>0:textproc/py-collective.checkdocs@${PY_FLAVOR}
- To install the port:
- cd /usr/ports/textproc/py-collective.checkdocs/ && make install clean
- To add the package, run one of these commands:
- pkg install textproc/py-collective.checkdocs
- pkg install py311-collective.checkdocs
NOTE: If this package has multiple flavors (see below), then use one of them instead of the name specified above. NOTE: This is a Python port. Instead of py311-collective.checkdocs listed in the above command, you can pick from the names under the Packages section.- PKGNAME: py311-collective.checkdocs
- Package flavors (<flavor>: <package>)
- py311: py311-collective.checkdocs
- distinfo:
- TIMESTAMP = 1605029614
SHA256 (collective.checkdocs-0.2.zip) = 3a5328257c5224bc72753820c182910d7fb336bc1dba5e09113d48566655e46e
SIZE (collective.checkdocs-0.2.zip) = 10865
Packages (timestamps in pop-ups are UTC):
- Dependencies
- NOTE: FreshPorts displays only information on required and default dependencies. Optional dependencies are not covered.
- Build dependencies:
-
- py311-setuptools>=63.1.0 : devel/py-setuptools@py311
- python3.11 : lang/python311
- Test dependencies:
-
- python3.11 : lang/python311
- Runtime dependencies:
-
- py311-docutils>=0.15 : textproc/py-docutils@py311
- python3.11 : lang/python311
- There are no ports dependent upon this port
Configuration Options:
- No options to configure
- Options name:
- textproc_py-collective.checkdocs
- USES:
- python zip
- FreshPorts was unable to extract/find any pkg message
- Master Sites:
|
Number of commits found: 9
Commit History - (may be incomplete: for full details, see links to repositories near top of page) |
Commit | Credits | Log message |
0.2_1 08 Mar 2025 04:05:21
    |
Charlie Li (vishwin)  |
python: bump all USE_PYTHON=distutils consumers after RUN_DEPENDS removal
Any missed ports, feel free to bump.
Any ports that need setuptools at runtime can have the devel/py-setuptools
manually added back to RUN_DEPENDS, but understand that this practice
is deprecated; see CHANGES for details. |
0.2 27 Jun 2023 19:34:34
    |
Rene Ladan (rene)  |
all: remove explicit versions in USES=python for "3.x+"
The logic in USES=python will automatically convert this to 3.8+ by
itself.
Adjust two ports that only had Python 3.7 mentioned but build fine
on Python 3.8 too.
finance/quickfix: mark BROKEN with PYTHON
libtool: compile: c++ -DHAVE_CONFIG_H -I. -I../.. -I -I. -I.. -I../.. -I../C++
-DLIBICONV_PLUG -DPYTHON_MAJOR_VERSION=3 -Wno-unused-variable
-Wno-maybe-uninitialized -O2 -pipe -DLIBICONV_PLUG -fstack-protector-strong
-fno-strict-aliasing -DLIBICONV_PLUG -Wall -ansi
-Wno-unused-command-line-argument -Wpointer-arith -Wwrite-strings
-Wno-overloaded-virtual -Wno-deprecated-declarations -Wno-deprecated -std=c++0x
-MT _quickfix_la-QuickfixPython.lo -MD -MP -MF
.deps/_quickfix_la-QuickfixPython.Tpo -c QuickfixPython.cpp -fPIC -DPIC -o
.libs/_quickfix_la-QuickfixPython.o
warning: unknown warning option '-Wno-maybe-uninitialized'; did you mean
'-Wno-uninitialized'? [-Wunknown-warning-option]
QuickfixPython.cpp:175:11: fatal error: 'Python.h' file not found
^~~~~~~~~~
1 warning and 1 error generated.
Reviewed by: portmgr, vishwin, yuri
Differential Revision: <https://reviews.freebsd.org/D40568> |
0.2 11 Jan 2023 15:58:34
    |
Dmitry Marakasov (amdmi3)  |
*/*: rename CHEESESHOP to PYPI in MASTER_SITES
PR: 267994
Differential revision: D37518
Approved by: bapt |
07 Sep 2022 21:58:51
    |
Stefan Eßer (se)  |
Remove WWW entries moved into port Makefiles
Commit b7f05445c00f has added WWW entries to port Makefiles based on
WWW: lines in pkg-descr files.
This commit removes the WWW: lines of moved-over URLs from these
pkg-descr files.
Approved by: portmgr (tcberner) |
0.2 07 Sep 2022 21:10:59
    |
Stefan Eßer (se)  |
Add WWW entries to port Makefiles
It has been common practice to have one or more URLs at the end of the
ports' pkg-descr files, one per line and prefixed with "WWW:". These
URLs should point at a project website or other relevant resources.
Access to these URLs required processing of the pkg-descr files, and
they have often become stale over time. If more than one such URL was
present in a pkg-descr file, only the first one was tarnsfered into
the port INDEX, but for many ports only the last line did contain the
port specific URL to further information.
There have been several proposals to make a project URL available as
a macro in the ports' Makefiles, over time.
(Only the first 15 lines of the commit message are shown above ) |
0.2 07 Apr 2021 08:09:01
    |
Mathieu Arnold (mat)  |
One more small cleanup, forgotten yesterday.
Reported by: lwhsu |
0.2 06 Apr 2021 14:31:07
    |
Mathieu Arnold (mat)  |
Remove # $FreeBSD$ from Makefiles. |
0.2 28 Dec 2020 23:02:15
  |
antoine  |
Drop python 2.7 support from a few ports
With hat: portmgr |
0.2 14 Nov 2020 19:42:40
  |
egypcio  |
[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 |
Number of commits found: 9
|