[Git][reproducible-builds/diffoscope][master] 2 commits: Manually strip out manpage-only parts of the README rather than using "only"...

[Chris Lamb]

Chris Lamb pushed to branch master at Reproducible Builds / diffoscope


Commits:
d06d0657 by Chris Lamb at 2019-05-29T09:49:07Z
Manually strip out manpage-only parts of the README rather than using "only" directive in order to support the latest PyPI website.

- - - - -
edb01aa2 by Chris Lamb at 2019-05-29T09:49:18Z
Use "real" reStructuredText comments instead of using the "raw" directive.

See <http://docutils.sourceforge.net/docs/user/rst/quickref.html#comments>.

- - - - -


2 changed files:

- README.rst
- doc/Makefile


Changes:

=====================================
README.rst
=====================================
@@ -1,13 +1,11 @@
 diffoscope
 ==========
 
-.. only:: not manpage
+.. image:: https://badge.fury.io/py/diffoscope.svg
+   :target: http://badge.fury.io/py/diffoscope
 
-   .. image:: https://badge.fury.io/py/diffoscope.svg
-       :target: http://badge.fury.io/py/diffoscope
-
-   .. image:: https://jenkins.debian.net/buildStatus/icon?job=reproducible_diffoscope_from_git_master&plastic=true
-      :target: https://jenkins.debian.net/job/reproducible_diffoscope_from_git_master
+.. image:: https://jenkins.debian.net/buildStatus/icon?job=reproducible_diffoscope_from_git_master&plastic=true
+  :target: https://jenkins.debian.net/job/reproducible_diffoscope_from_git_master
 
 diffoscope will try to get to the bottom of what makes files or
 directories different. It will recursively unpack archives of many kinds
@@ -31,10 +29,8 @@ started, as well as more detailed explanations of all the command-line
 options. The same information is also available in
 ``/usr/share/doc/diffoscope/README.rst`` or similar.
 
-.. raw:: manpage
-
-   .\" the below hack gets rid of the python "usage" message in favour of the
-   .\" the synopsis we manually defined in doc/$(PACKAGE).h2m.0
+.. the below hack gets rid of the python "usage" message in favour of the the
+   synopsis we manually defined in doc/$(PACKAGE).h2m.0
    .SS positional arguments:
    .\" end_of_description_header
 


=====================================
doc/Makefile
=====================================
@@ -5,6 +5,10 @@
 PACKAGE = diffoscope
 VERSION = $$(cd .. && python3 setup.py -V)
 SED_fix_package_quirks = -e 's,bin/diffoscope,diffoscope,g'
+SED_fix_README_quirks = \
+  -e '/^\.\. raw:: /d' \
+  -e '/^\.\. image:: /d' \
+  -e '/ :target: /d'
 
 SED_rm_python_usage_msg = -e '/end_of_description_header/,/positional arguments/{d}'
 SED_fix_rst2man_quirks = \
@@ -23,6 +27,7 @@ $(PACKAGE).1: $(PACKAGE).h2m ../$(PACKAGE)/__init__.py
 
 $(PACKAGE).h2m: $(PACKAGE).h2m.0 ../README.rst Makefile
 	{ cat $(PACKAGE).h2m.0; cat ../README.rst | \
+	  sed $(SED_fix_README_quirks) | tee out.txt | \
 	  rst2man -q --no-doc-title | \
 	  sed $(SED_fix_rst2man_quirks) \
 	      $(SED_fix_package_quirks) \



View it on GitLab: https://salsa.debian.org/reproducible-builds/diffoscope/compare/2cb8206c4b981b7bb8562799b5fcbbe79e428ac7...edb01aa2fd8b56abce21db476eef86543ff51901

-- 
View it on GitLab: https://salsa.debian.org/reproducible-builds/diffoscope/compare/2cb8206c4b981b7bb8562799b5fcbbe79e428ac7...edb01aa2fd8b56abce21db476eef86543ff51901
You're receiving this email because of your account on salsa.debian.org.

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.reproducible-builds.org/pipermail/rb-commits/attachments/20190529/26a6a2c9/attachment.html>