pnuckowski/aioresponses

0.7.2: sphinx warnings

kloczek opened this issue · 0 comments

First of all looks like it is small bug in setup.g which points to wrong directory

--- a/setup.cfg~        2021-03-09 08:06:17.000000000 +0000
+++ b/setup.cfg 2021-09-07 14:52:10.569305402 +0100
@@ -27,7 +27,7 @@
 [build_sphinx]
 all_files = 1
 build-dir = docs/build
-source-dir = docs/source
+source-dir = docs

 [bdist_wheel]
 universal = 1

With that patch is possibel to use now setuptoolx<>sphins integration which sjows with latest sphinx some warnings:

+ /usr/bin/python3 setup.py build_sphinx -b man --build-dir build/sphinx
/usr/lib/python3.8/site-packages/setuptools/dist.py:714: 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.8/site-packages/setuptools/dist.py:714: 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.8/site-packages/setuptools/dist.py:714: UserWarning: Usage of dash-separated 'home-page' will not be supported in future versions. Please use the underscore name 'home_page' instead
  warnings.warn(
/usr/lib/python3.8/site-packages/setuptools/dist.py:714: 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.8/site-packages/setuptools/dist.py:714: 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.8/site-packages/setuptools/dist.py:714: 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 build_sphinx
[pbr] Generating AUTHORS
[pbr] AUTHORS complete (0.0s)
[pbr] Sphinx 1.6 added native support for specifying multiple builders in the '[sphinx_build] builder' configuration option, found in 'setup.cfg'. As a result, the '[sphinx_build] builders' option has been deprecated and will be removed in pbr 4.0. Migrate to the 'builder' configuration option.
Running Sphinx v4.1.2
making output directory... done
WARNING: html_static_path entry '_static' does not exist
building [mo]: all of 0 po files
building [man]: all source files
updating environment: [new config] 9 added, 0 changed, 0 removed
reading sources... [100%] usage
/home/tkloczko/rpmbuild/BUILD/aioresponses-0.7.2/docs/index.rst:7: WARNING: Title underline too short.

Welcome to aioresponses's documentation!
======================================
/home/tkloczko/rpmbuild/BUILD/aioresponses-0.7.2/docs/index.rst:11: WARNING: toctree contains reference to nonexisting document 'authorshistory'
looking for now-outdated files... none found
pickling environment... done
checking consistency... /home/tkloczko/rpmbuild/BUILD/aioresponses-0.7.2/docs/authors.rst: WARNING: document isn't included in any toctree
/home/tkloczko/rpmbuild/BUILD/aioresponses-0.7.2/docs/history.rst: WARNING: document isn't included in any toctree
/home/tkloczko/rpmbuild/BUILD/aioresponses-0.7.2/docs/modules.rst: WARNING: document isn't included in any toctree
done
writing... python-aioresponses.3 { readme installation usage contributing } done
build succeeded, 6 warnings.