Automatically removing "badges" pictures from README.rst files
Hi team! In many OpenStack packages, README.rst files are infected with badges. For example, nova-client here: https://opendev.org/openstack/python-novaclient/src/branch/master/README.rst As I'm a good Debian citizen, I'm removing them from the resulting sphinx doc, because as Lintian warns, it's a privacy breach, and also because without internet access, the picture just not render. The problem is that patching the README.rst files is very time consuming. The number I had to rebase this type of patches is countless. Therefore, I was wondering if anyone thought about an automated way to remove these. Maybe we could have some options for dh_sphinxdoc? Thoughts anyone? Cheers, Thomas Goirand (zigo)
RE:Automatically removing "badges" pictures from README.rst files
what about lintian brush ?
Re: Automatically removing "badges" pictures from README.rst files
On 4/9/20 10:05 PM, PICCA Frederic-Emmanuel wrote: > what about lintian brush ? > What's that? Thomas
Re: Automatically removing "badges" pictures from README.rst files
On 2020-04-10 00:25:41 +0200 (+0200), Thomas Goirand wrote: > On 4/9/20 10:05 PM, PICCA Frederic-Emmanuel wrote: > > what about lintian brush ? > > What's that? This: automatically fix lintian problems This package contains a set of scripts that can automatically fix more than 80 common lintian issues in Debian packages. It comes with a wrapper script that invokes the scripts, updates the changelog (if desired) and commits each change to version control. (from https://packages.debian.org/lintian-brush ) -- Jeremy Stanley signature.asc Description: PGP signature
Re: Fwd: [covid] New Contributor for biohackathon
Thank you for the assistance with this! I have uploaded my package to the appropriate repository under the Python Modules team and will reach out for a RFS.
Re: Automatically removing "badges" pictures from README.rst files
Hello, On 2020-04-09 22:20, Thomas Goirand wrote: > Therefore, I was wondering if anyone thought about an automated way to > remove these. Maybe we could have some options for dh_sphinxdoc? I agree that debhelper should be handling this issue. However, the issue occurs in packages not using sphinx too, so I feel there should be a more generic tool. Lintian-brush is a fine tool, but (correct me if I am wrong) it would generate a patch excluding badges, and patches require maintenance. Best, Andrius
Re: Fwd: [covid] New Contributor for biohackathon
On 4/9/20 7:37 PM, fancycade wrote: > Thank you for the assistance with this! > > I have uploaded my package to the appropriate repository under the > Python Modules team and will reach out for a RFS. Great, thanks for your contribution! -Olek signature.asc Description: OpenPGP digital signature
RE:Automatically removing "badges" pictures from README.rst files
> Lintian-brush is a fine tool, but (correct me if I am wrong) it would > generate a patch excluding badges, and patches require maintenance. You are right maybe we should have a dh_privacy helper for this purpose. cheers Fred
