Deprecation warnings

[grawlinson]

I'm in the process of packaging this for Arch Linux, there's quite a few deprecation warnings displayed when building this using either legacy setup.py or the build module (PEP-517 compatible).

/usr/lib/python3.10/site-packages/setuptools/dist.py:770: UserWarning: Usage of dash-separated 'description-file' will not be supported in future versions. Please use the underscore name 'description_file' instead
  warnings.warn(
/usr/lib/python3.10/site-packages/setuptools/dist.py:770: UserWarning: Usage of dash-separated 'author-email' will not be supported in future versions. Please use the underscore name 'author_email' instead
  warnings.warn(
/usr/lib/python3.10/site-packages/setuptools/dist.py:770: UserWarning: Usage of dash-separated 'home-page' will not be supported in future versions. Please use the underscore name 'home_page' instead
  warnings.warn(
[pbr] Generating ChangeLog
/usr/lib/python3.10/site-packages/setuptools/command/easy_install.py:144: EasyInstallDeprecationWarning: easy_install command is deprecated. Use build and pip and other standards-based tools.
  warnings.warn(
/usr/lib/python3.10/site-packages/setuptools/command/install.py:34: SetuptoolsDeprecationWarning: setup.py install is deprecated. Use build and pip and other standards-based tools.
  warnings.warn(
/usr/lib/python3.10/site-packages/setuptools/dist.py:770: UserWarning: Usage of dash-separated 'description-file' will not be supported in future versions. Please use the underscore name 'description_file' instead
  warnings.warn(
/usr/lib/python3.10/site-packages/setuptools/dist.py:770: UserWarning: Usage of dash-separated 'author-email' will not be supported in future versions. Please use the underscore name 'author_email' instead
  warnings.warn(
/usr/lib/python3.10/site-packages/setuptools/dist.py:770: UserWarning: Usage of dash-separated 'home-page' will not be supported in future versions. Please use the underscore name 'home_page' instead
  warnings.warn(
running install
[pbr] Writing ChangeLog
[pbr] Generating ChangeLog
[pbr] ChangeLog complete (0.0s)
[pbr] Generating AUTHORS
[pbr] AUTHORS complete (0.0s)
running build

For some reason, some warnings are displayed twice.

• The dash-separated ones are easily fixable:

--- a/setup.cfg
+++ b/setup.cfg
@@ -1,11 +1,11 @@
 [metadata]
 name = sphinxcontrib-fulltoc
 summary = Include a full table of contents in your Sphinx HTML sidebar
-description-file =
+description_file =
     README.rst
 author = Doug Hellmann
-author-email = doug@doughellmann.com
-home-page = http://sphinxcontrib-fulltoc.readthedocs.org
+author_email = doug@doughellmann.com
+home_page = https://sphinxcontrib-fulltoc.readthedocs.org
 classifier =
     Development Status :: 4 - Beta
     Environment :: Console

• The python setup.py build/install one is trivial (we are migrating away from using setup.py because it is legacy).

• The easy_install one seems to be linked to the usage of the pbr module. I suggest that moving away from pbr would be in this project's best interest.

[t-b]

Related warning on debian bookworm:

DEPRECATION: sphinxcontrib-fulltoc is being installed using the legacy 'setup.py
install' method, because it does not have a 'pyproject.toml' and the 'wheel'
package is not installed. pip 23.1 will enforce this behaviour change.
A possible replacement is to enable the '--use-pep517' option. Discussion can be found at https://github.com/pypa/pip/issues/8559

[t-vi]

I'm a happy user of sphinx-contrib fulldoc (thank you)!
This became more urgent (to me) with sphinx-contrib fulldoc failing to install in my setup.
#27 suggests to switch to pyproject.toml . @dhellmann could you be interested?

[dhellmann]

I don't have time to do anything with it myself, but if you submit a PR I'll review it and prep a release. Please use flit-core or hatchling, not setuptools (too many breaking changes lately, I don't want to deal with it any more).