maintainer-feedback requested: [Bug 245629] textproc/py-sphinx: Update to 3.0.1

[bugzilla-noreply at freebsd.org]

Bugzilla Automation <bugzilla at FreeBSD.org> has asked freebsd-python mailing
list <python at FreeBSD.org> for maintainer-feedback:
Bug 245629: textproc/py-sphinx: Update to 3.0.1
https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=245629



--- Description ---
Before applying the patch:
  $ svn cp textproc/py-sphinx textproc/py-sphinx18
  $ svn patch sphinx-v3.0.1-v1.8.5-PR.patch

Plan:

- Repocopy textproc/py-sphinx to textproc/py-sphinx18, then upgrade it to 1.8.5
(latest version from 1.8.X).

  This version supports Python 2 and 3.
  Add test target.

- textproc/py-sphinx: Update to 3.0.1

  Python 3 only, 3.5+
  Add test target.
  Add new ports (PR's will be linked here)

- Mk/Uses/python.mk: Add PY_SPHINX

  To use with flavors and not break ports with USES=python (all versions).
    Python >=3.5  --> textproc/py-sphinx (v3.0.1)
    Python < 3.5  --> textproc/py-sphinx18 (v1.8.5)

  All ports that uses sphinx were changed to use the new variable ${PY_SPHINX}
in the dependency line, exceptions:

    * Ports that fails to build with sphinx 3.0.1 because of code. 
      They are pointing to textproc/py-sphinx18 directly.
      There aren't many ports.

    * Ports that don't know Python flavors.


- Add several patches to fix sphinx consumers

  The most common issues are related with pkg-plist, the output files from
sphinx changes between versions, I tried to keep ports generating it
dynamically. 
  This will save our time in the future sphinx updates.


Tests:

  mini exp-run on all consumers, 2412 ports (all flavors).

  textproc/py-sphinx18:
    make test: 4 failed, 1324 passed, 23 skipped, 487 warnings in 84.17 seconds
	test_correct_year[expect_date1] - tests/test_correct_year.py:37:
AssertionErro
	test_ext_imgconverter - tests/test_ext_imgconverter.py:23:
AssertionError
	test_text_definition_terms - tests/test_intl.py:268: AssertionError
	test_gettext_definition_terms - tests/test_intl.py:530: AssertionError

  textproc/py-sphinx:
    make test:	1 failed, 1432 passed, 29 skipped, 37 warnings in 97.99 seconds
	WARNING: convert command 'convert' cannot be run, check the
image_converter setting
	needs to investigate, docutils, imagemagick related

  IMHO this is very reasonable result, if you compare them with the current
version (which is not even working in the tree):
    textproc/py-sphinx (current version in the ports tree v1.6.5):
	make test: 2 failed, 188 passed, 9 skipped, 36 warnings, 956 error in
11.96 seconds

  But tests can certainly be improved in the following updates.



Looking forward for your feedback.
And if this patch is fine, I Would like to ask for an exp-run.