bottlepy / bottle

bottle.py is a fast and simple micro-framework for python web-applications.
http://bottlepy.org/
MIT License
8.33k stars 1.46k forks source link

0.12.19: sphinx 4.x warnings #1349

Closed kloczek closed 2 years ago

kloczek commented 2 years ago

Looks like new sphinx shows some warning during documentation build

+ /usr/bin/python3 setup.py build_sphinx -b man --build-dir build/sphinx
running build_sphinx
Running Sphinx v4.1.2
making output directory... done
loading intersphinx inventory from http://docs.python.org/objects.inv...
loading intersphinx inventory from http://werkzeug.pocoo.org/docs/objects.inv...
intersphinx inventory has moved: http://docs.python.org/objects.inv -> https://docs.python.org/3/objects.inv
intersphinx inventory has moved: http://werkzeug.pocoo.org/docs/objects.inv -> https://werkzeug.palletsprojects.com/en/2.0.x/objects.inv
building [mo]: targets for 0 po files that are out of date
building [man]: all manpages
updating environment: [new config] 18 added, 0 changed, 0 removed
reading sources... [100%] tutorial_app
/home/tkloczko/rpmbuild/BUILD/bottle-0.12.19/bottle.py:docstring of bottle.request:1: WARNING: duplicate object description of bottle.request, other instance in api, use :noindex: for one of them
/home/tkloczko/rpmbuild/BUILD/bottle-0.12.19/bottle.py:docstring of bottle.ConfigDict.load_config:1: WARNING: Inline emphasis start-string without end-string.
/home/tkloczko/rpmbuild/BUILD/bottle-0.12.19/docs/contact.rst:: WARNING: image file not readable: _static/myface_small.png
/home/tkloczko/rpmbuild/BUILD/bottle-0.12.19/docs/faq.rst:1: WARNING: duplicate object description of bottle, other instance in api, use :noindex: for one of them
/home/tkloczko/rpmbuild/BUILD/bottle-0.12.19/docs/plugindev.rst:1: WARNING: duplicate object description of bottle, other instance in faq, use :noindex: for one of them
/home/tkloczko/rpmbuild/BUILD/bottle-0.12.19/docs/plugins/index.rst:1: WARNING: duplicate object description of bottle, other instance in plugindev, use :noindex: for one of them
/home/tkloczko/rpmbuild/BUILD/bottle-0.12.19/docs/recipes.rst:1: WARNING: duplicate object description of bottle, other instance in plugins/index, use :noindex: for one of them
/home/tkloczko/rpmbuild/BUILD/bottle-0.12.19/docs/tutorial.rst:1: WARNING: duplicate object description of bottle, other instance in recipes, use :noindex: for one of them
looking for now-outdated files... none found
pickling environment... done
checking consistency... /home/tkloczko/rpmbuild/BUILD/bottle-0.12.19/docs/contact.rst: WARNING: document isn't included in any toctree
/home/tkloczko/rpmbuild/BUILD/bottle-0.12.19/docs/deployment.rst: WARNING: document isn't included in any toctree
done
writing... python-bottle.3 { tutorial configuration routing stpl api plugins/index plugins/sqlite plugins/werkzeug tutorial_app async recipes faq changelog development plugindev } /home/tkloczko/rpmbuild/BUILD/bottle-0.12.19/docs/tutorial.rst:175: WARNING: unknown document: Routing
/home/tkloczko/rpmbuild/BUILD/bottle-0.12.19/docs/tutorial.rst:287: WARNING: undefined label: tutorial-output-filter
/home/tkloczko/rpmbuild/BUILD/bottle-0.12.19/docs/stpl.rst:89: WARNING: undefined label: stpl-custom-tokens
done
build succeeded, 13 warnings.
kloczek commented 2 years ago

You can peak on fixes that kind of issues in other projects https://github.com/latchset/jwcrypto/pull/289 https://github.com/click-contrib/sphinx-click/commit/abc31069 https://github.com/latchset/jwcrypto/pull/289 https://github.com/RDFLib/rdflib-sqlalchemy/issues/95 https://github.com/sissaschool/elementpath/commit/bf869d9e https://github.com/jaraco/cssutils/issues/21

defnull commented 2 years ago

Documentation still builds, though? release-0.12 is in maintenance mode. I'd merge PRs that fix these issues, but a couple of warnings are fine for a 9+ years old branch I guess.

kloczek commented 2 years ago

Closing tickets without fixing the issue does not make any sense. I'm not affected by this issue because I'm interested roff output (man page). This issue affects html and other output formats.

defnull commented 2 years ago

I explained why this is a "wontfix" situation. If you think this should be fixed (in a 9 years old maintenance branch), then feel free to submit a pull request.