Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

0.11.1: sphinx 4.x warnings #521

Open
kloczek opened this issue Aug 17, 2021 · 3 comments
Open

0.11.1: sphinx 4.x warnings #521

kloczek opened this issue Aug 17, 2021 · 3 comments

Comments

@kloczek
Copy link

kloczek commented Aug 17, 2021

[tkloczko@barrel toolz-0.11.1]$ /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
WARNING: html_static_path entry '_static' does not exist
[autosummary] generating autosummary for: api.rst, composition.rst, control.rst, curry.rst, heritage.rst, index.rst, install.rst, laziness.rst, parallelism.rst, purity.rst, references.rst, streaming-analytics.rst, tips-and-tricks.rst
building [mo]: targets for 0 po files that are out of date
building [man]: all manpages
updating environment: [new config] 13 added, 0 changed, 0 removed
reading sources... [100%] tips-and-tricks
/home/tkloczko/rpmbuild/BUILD/toolz-0.11.1/toolz/itertoolz.py:docstring of toolz.itertoolz.join:7: WARNING: Unexpected indentation.
/home/tkloczko/rpmbuild/BUILD/toolz-0.11.1/toolz/itertoolz.py:docstring of toolz.itertoolz.reduceby:24: WARNING: Unexpected section title.

Simple Examples
---------------
/home/tkloczko/rpmbuild/BUILD/toolz-0.11.1/toolz/itertoolz.py:docstring of toolz.itertoolz.reduceby:38: WARNING: Unexpected section title.

Complex Example
---------------
/home/tkloczko/rpmbuild/BUILD/toolz-0.11.1/toolz/itertoolz.py:docstring of toolz.itertoolz.reduceby:51: WARNING: Unexpected section title.

Example Using ``init``
----------------------
/home/tkloczko/rpmbuild/BUILD/toolz-0.11.1/toolz/functoolz.py:docstring of toolz.functoolz.excepts:8: WARNING: Unexpected section title.

Examples
--------
/home/tkloczko/rpmbuild/BUILD/toolz-0.11.1/toolz/sandbox/parallel.py:docstring of toolz.sandbox.parallel.fold:7: WARNING: Definition list ends without a blank line; unexpected unindent.
/home/tkloczko/rpmbuild/BUILD/toolz-0.11.1/toolz/sandbox/parallel.py:docstring of toolz.sandbox.parallel.fold:32: WARNING: Unexpected section title.

Example
-------
/home/tkloczko/rpmbuild/BUILD/toolz-0.11.1/doc/source/laziness.rst:103: WARNING: Footnote [1] is not referenced.
looking for now-outdated files... none found
pickling environment... done
checking consistency... /home/tkloczko/rpmbuild/BUILD/toolz-0.11.1/doc/source/heritage.rst:42: WARNING: Citation [itertools] is not referenced.
/home/tkloczko/rpmbuild/BUILD/toolz-0.11.1/doc/source/heritage.rst:43: WARNING: Citation [functools] is not referenced.
/home/tkloczko/rpmbuild/BUILD/toolz-0.11.1/doc/source/heritage.rst:44: WARNING: Citation [itertoolz] is not referenced.
/home/tkloczko/rpmbuild/BUILD/toolz-0.11.1/doc/source/heritage.rst:45: WARNING: Citation [functoolz] is not referenced.
/home/tkloczko/rpmbuild/BUILD/toolz-0.11.1/doc/source/heritage.rst:46: WARNING: Citation [Underscore.js] is not referenced.
/home/tkloczko/rpmbuild/BUILD/toolz-0.11.1/doc/source/heritage.rst:47: WARNING: Citation [cheatsheet] is not referenced.
/home/tkloczko/rpmbuild/BUILD/toolz-0.11.1/doc/source/heritage.rst:48: WARNING: Citation [Guido] is not referenced.
/home/tkloczko/rpmbuild/BUILD/toolz-0.11.1/doc/source/heritage.rst:49: WARNING: Citation [Enumerable] is not referenced.
/home/tkloczko/rpmbuild/BUILD/toolz-0.11.1/doc/source/heritage.rst:50: WARNING: Citation [funcy] is not referenced.
/home/tkloczko/rpmbuild/BUILD/toolz-0.11.1/doc/source/heritage.rst:51: WARNING: Citation [fn.py] is not referenced.
done
writing... toolz.1 { heritage install composition purity laziness control curry streaming-analytics parallelism api tips-and-tricks references } done
build succeeded, 19 warnings.
@eriknw
Copy link
Member

eriknw commented Oct 28, 2021

Thanks @kloczek. I haven't run this command in quite some time. I can confirm that I see these warnings too.

@kloczek
Copy link
Author

kloczek commented Oct 28, 2021

Thx for the confirmation :)
This functionaly is part of thr setuptoos<>sphinx integration (https://www.sphinx-doc.org/en/master/usage/advanced/setuptools.html) whioch is very usefull on packaging because it allow generate documentation in any format in any project without care where actriually copy.py file is located :P

@eriknw
Copy link
Member

eriknw commented Oct 28, 2021

Cool! I'll try to get these fixed, and may ask for help if I can't figure it out.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants