celery / py-amqp

amqplib fork
Other
308 stars 194 forks source link

5.0.6: sphinx warnings #362

Open kloczek opened 3 years ago

kloczek commented 3 years ago

Looks like new sphinx shows some warning on building documentation

+ /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 https://docs.python.org/dev/objects.inv...
loading intersphinx inventory from https://www.sphinx-doc.org/en/stable/objects.inv...
intersphinx inventory has moved: https://www.sphinx-doc.org/en/stable/objects.inv -> https://www.sphinx-doc.org/en/master/objects.inv
building [mo]: targets for 0 po files that are out of date
building [man]: all manpages
updating environment: [new config] 16 added, 0 changed, 0 removed
reading sources... [100%] reference/index
Changelog:87: WARNING: Inline emphasis start-string without end-string.
Changelog:170: WARNING: Bullet list ends without a blank line; unexpected unindent.
Changelog:175: WARNING: Duplicate explicit target name: "version-2.6.0".
Changelog:226: WARNING: Bullet list ends without a blank line; unexpected unindent.
/home/tkloczko/rpmbuild/BUILD/py-amqp-5.0.6/docs/../amqp/channel.py:docstring of amqp.channel.Channel.basic_qos:66: WARNING: Definition list ends without a blank line; unexpected unindent.
/home/tkloczko/rpmbuild/BUILD/py-amqp-5.0.6/docs/../amqp/connection.py:docstring of amqp.connection.Connection:19: WARNING: Literal block ends without a blank line; unexpected unindent.
/home/tkloczko/rpmbuild/BUILD/py-amqp-5.0.6/docs/../amqp/channel.py:docstring of amqp.channel.Channel.basic_qos:66: WARNING: Definition list ends without a blank line; unexpected unindent.
docstring of amqp.connection.Connection.negotiate_capabilities:7: WARNING: Unexpected indentation.
docstring of amqp.connection.Connection.negotiate_capabilities:9: WARNING: Definition list ends without a blank line; unexpected unindent.
docstring of amqp.connection.Connection.negotiate_capabilities:10: WARNING: Block quote ends without a blank line; unexpected unindent.
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... python-amqp.3 { reference/index reference/amqp.connection reference/amqp.channel reference/amqp.basic_message reference/amqp.exceptions reference/amqp.abstract_channel reference/amqp.transport reference/amqp.method_framing reference/amqp.platform reference/amqp.protocol reference/amqp.sasl reference/amqp.serialization reference/amqp.spec reference/amqp.utils changelog } Changelog:648: WARNING: undefined label: vine:version-1.1.3
Changelog:672: WARNING: undefined label: vine:version-1.1.2
done
build succeeded, 12 warnings.
auvipy commented 3 years ago

is it on current master?

kloczek commented 3 years ago

I have no idea. My ticket is about 5.0.6.

kloczek commented 2 years ago

Just tested 5.0.8.

+ /usr/bin/python3 setup.py build_sphinx -b man --build-dir build/sphinx
running build_sphinx
Running Sphinx v4.3.1
making output directory... done
loading intersphinx inventory from https://docs.python.org/dev/objects.inv...
loading intersphinx inventory from https://www.sphinx-doc.org/en/stable/objects.inv...
intersphinx inventory has moved: https://www.sphinx-doc.org/en/stable/objects.inv -> https://www.sphinx-doc.org/en/master/objects.inv
building [mo]: targets for 0 po files that are out of date
building [man]: all manpages
updating environment: [new config] 16 added, 0 changed, 0 removed
reading sources... [100%] reference/index
Changelog:111: WARNING: Inline emphasis start-string without end-string.
Changelog:194: WARNING: Bullet list ends without a blank line; unexpected unindent.
Changelog:199: WARNING: Duplicate explicit target name: "version-2.6.0".
Changelog:250: WARNING: Bullet list ends without a blank line; unexpected unindent.
/home/tkloczko/rpmbuild/BUILD/py-amqp-5.0.8/docs/../amqp/channel.py:docstring of amqp.channel.Channel.basic_qos:66: WARNING: Definition list ends without a blank line; unexpected unindent.
/home/tkloczko/rpmbuild/BUILD/py-amqp-5.0.8/docs/../amqp/connection.py:docstring of amqp.connection.Connection:19: WARNING: Literal block ends without a blank line; unexpected unindent.
/home/tkloczko/rpmbuild/BUILD/py-amqp-5.0.8/docs/../amqp/channel.py:docstring of amqp.channel.Channel.basic_qos:66: WARNING: Definition list ends without a blank line; unexpected unindent.
docstring of amqp.connection.Connection.negotiate_capabilities:7: WARNING: Unexpected indentation.
docstring of amqp.connection.Connection.negotiate_capabilities:9: WARNING: Definition list ends without a blank line; unexpected unindent.
docstring of amqp.connection.Connection.negotiate_capabilities:10: WARNING: Block quote ends without a blank line; unexpected unindent.
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... python-amqp.3 { reference/index reference/amqp.connection reference/amqp.channel reference/amqp.basic_message reference/amqp.exceptions reference/amqp.abstract_channel reference/amqp.transport reference/amqp.method_framing reference/amqp.platform reference/amqp.protocol reference/amqp.sasl reference/amqp.serialization reference/amqp.spec reference/amqp.utils changelog } Changelog:672: WARNING: undefined label: vine:version-1.1.3
Changelog:696: WARNING: undefined label: vine:version-1.1.2
done
build succeeded, 12 warnings.
kloczek commented 2 years ago

Just tested 5.1.1 and now there are more warnings

[tkloczko@devel-g2v py-amqp-5.1.1]$ /usr/bin/sphinx-build -n -T -b man docs build/sphinx/man
Running Sphinx v4.5.0
making output directory... done
loading intersphinx inventory from https://docs.python.org/dev/objects.inv...
loading intersphinx inventory from https://www.sphinx-doc.org/en/stable/objects.inv...
intersphinx inventory has moved: https://www.sphinx-doc.org/en/stable/objects.inv -> https://www.sphinx-doc.org/en/master/objects.inv
building [mo]: targets for 0 po files that are out of date
building [man]: all manpages
updating environment: [new config] 16 added, 0 changed, 0 removed
reading sources... [100%] reference/index
Changelog:145: WARNING: Inline emphasis start-string without end-string.
Changelog:228: WARNING: Bullet list ends without a blank line; unexpected unindent.
Changelog:233: WARNING: Duplicate explicit target name: "version-2.6.0".
Changelog:284: WARNING: Bullet list ends without a blank line; unexpected unindent.
/home/tkloczko/rpmbuild/BUILD/py-amqp-5.1.1/docs/../amqp/channel.py:docstring of amqp.channel.Channel.basic_qos:66: WARNING: Definition list ends without a blank line; unexpected unindent.
/home/tkloczko/rpmbuild/BUILD/py-amqp-5.1.1/docs/../amqp/connection.py:docstring of amqp.connection.Connection:19: WARNING: Literal block ends without a blank line; unexpected unindent.
/home/tkloczko/rpmbuild/BUILD/py-amqp-5.1.1/docs/../amqp/channel.py:docstring of amqp.channel.Channel.basic_qos:66: WARNING: Definition list ends without a blank line; unexpected unindent.
docstring of amqp.connection.Connection.negotiate_capabilities:7: ERROR: Unexpected indentation.
docstring of amqp.connection.Connection.negotiate_capabilities:9: WARNING: Definition list ends without a blank line; unexpected unindent.
docstring of amqp.connection.Connection.negotiate_capabilities:10: WARNING: Block quote ends without a blank line; unexpected unindent.
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... python-amqp.3 { reference/index reference/amqp.connection reference/amqp.channel reference/amqp.basic_message reference/amqp.exceptions reference/amqp.abstract_channel reference/amqp.transport reference/amqp.method_framing reference/amqp.platform reference/amqp.protocol reference/amqp.sasl reference/amqp.serialization reference/amqp.spec reference/amqp.utils changelog } /home/tkloczko/rpmbuild/BUILD/py-amqp-5.1.1/docs/../amqp/transport.py:docstring of amqp.transport.SSLTransport._wrap_context:19: WARNING: py:attr reference target not found: ssl.create_default_context
/home/tkloczko/rpmbuild/BUILD/py-amqp-5.1.1/docs/../amqp/transport.py:docstring of amqp.transport.SSLTransport._wrap_socket_sni:27: WARNING: py:attr reference target not found: ssl.CERT_NONE
/home/tkloczko/rpmbuild/BUILD/py-amqp-5.1.1/docs/../amqp/transport.py:docstring of amqp.transport.SSLTransport._wrap_socket_sni:27: WARNING: py:attr reference target not found: ssl.CERT_NONE
/home/tkloczko/rpmbuild/BUILD/py-amqp-5.1.1/docs/../amqp/transport.py:docstring of amqp.transport.SSLTransport._wrap_socket_sni:27: WARNING: py:attr reference target not found: ssl.CERT_OPTIONAL
/home/tkloczko/rpmbuild/BUILD/py-amqp-5.1.1/docs/../amqp/transport.py:docstring of amqp.transport.SSLTransport._wrap_socket_sni:27: WARNING: py:attr reference target not found: ssl.CERT_REQUIRED
/home/tkloczko/rpmbuild/BUILD/py-amqp-5.1.1/docs/../amqp/transport.py:docstring of amqp.transport.SSLTransport._wrap_socket_sni:33: WARNING: py:attr reference target not found: ssl.CERT_NONE
<unknown>:1: WARNING: py:class reference target not found: amqp.sasl._get_gssapi_mechanism.<locals>.FakeGSSAPI
Changelog:644: WARNING: py:data reference target not found: socket.TCP_USER_TIMEOUT
Changelog:649: WARNING: py:class reference target not found: amqp.Connection
Changelog:706: WARNING: undefined label: vine:version-1.1.3
Changelog:730: WARNING: undefined label: vine:version-1.1.2
Changelog:914: WARNING: py:exc reference target not found: amqp.exceptions.NotConfirmed
Changelog:1097: WARNING: py:class reference target not found: amqp.protocol.basic_declare_ok_t
Changelog:1122: WARNING: py:meth reference target not found: amqp.utils.promise
Changelog:1160: WARNING: py:class reference target not found: amqp.AMQPError
Changelog:1149: WARNING: py:class reference target not found: amqp.ConnectionError
Changelog:1139: WARNING: py:class reference target not found: amqp.RecoverableConnectionError
Changelog:1138: WARNING: py:class reference target not found: amqp.ConsumerCancelled
Changelog:1139: WARNING: py:class reference target not found: amqp.ConnectionForced
Changelog:1140: WARNING: py:class reference target not found: amqp.ResourceError
Changelog:1149: WARNING: py:class reference target not found: IrrecoverableConnectionError
Changelog:1142: WARNING: py:class reference target not found: amqp.ChannelNotOpen
Changelog:1143: WARNING: py:class reference target not found: amqp.FrameError
Changelog:1144: WARNING: py:class reference target not found: amqp.FrameSyntaxError
Changelog:1145: WARNING: py:class reference target not found: amqp.InvalidCommand
Changelog:1146: WARNING: py:class reference target not found: amqp.InvalidPath
Changelog:1147: WARNING: py:class reference target not found: amqp.NotAllowed
Changelog:1148: WARNING: py:class reference target not found: amqp.UnexpectedFrame
Changelog:1149: WARNING: py:class reference target not found: amqp.AMQPNotImplementedError
Changelog:1150: WARNING: py:class reference target not found: amqp.InternalError
Changelog:1160: WARNING: py:class reference target not found: amqp.ChannelError
Changelog:1154: WARNING: py:class reference target not found: RecoverableChannelError
Changelog:1153: WARNING: py:class reference target not found: amqp.ContentTooLarge
Changelog:1154: WARNING: py:class reference target not found: amqp.NoConsumers
Changelog:1155: WARNING: py:class reference target not found: amqp.ResourceLocked
Changelog:1160: WARNING: py:class reference target not found: IrrecoverableChannelError
Changelog:1157: WARNING: py:class reference target not found: amqp.AccessRefused
Changelog:1158: WARNING: py:class reference target not found: amqp.NotFound
Changelog:1159: WARNING: py:class reference target not found: amqp.PreconditionFailed
Changelog:1299: WARNING: py:data reference target not found: amqp.exceptions.METHOD_NAME_MAP
done
build succeeded, 50 warnings.
auvipy commented 2 years ago

thanks you, can you help to remove the warnings?

kloczek commented 2 years ago

To be honest I have no enough exp on that area😞