2.0.0: sphinx warnings

[kloczek]

• Bug Report
• Feature Request
• Documentation Report
• General Enhancement Idea
• ...

Versions & Configuration

sphinx 4.0.2

Please specify the following things:
2.0.0
pythom 3.8.9
Linux x86_64

+ /usr/bin/python3 setup.py build_sphinx -b man --build-dir build/sphinx
running build_sphinx
Running Sphinx v4.0.2
making output directory... done
WARNING: html_static_path entry 'sure_docs_static' does not exist
loading intersphinx inventory from https://docs.python.org/objects.inv...
loading intersphinx inventory from https://redis-py.readthedocs.io/en/latest/objects.inv...
intersphinx inventory has moved: https://docs.python.org/objects.inv -> https://docs.python.org/3/objects.inv
building [mo]: targets for 0 po files that are out of date
building [man]: all manpages
updating environment: [new config] 7 added, 0 changed, 0 removed
reading sources... [100%] tutorial
/home/tkloczko/rpmbuild/BUILD/sure-2.0.0/docs/source/api-reference.rst:120: WARNING: Title underline too short.

``tests/test_filesystem.py``
........................
/home/tkloczko/rpmbuild/BUILD/sure-2.0.0/docs/source/api-reference.rst:120: WARNING: Title underline too short.

``tests/test_filesystem.py``
........................
/home/tkloczko/rpmbuild/BUILD/sure-2.0.0/docs/source/api-reference.rst:402: WARNING: Title level inconsistent:

``.have.property().being.*``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
/home/tkloczko/rpmbuild/BUILD/sure-2.0.0/docs/source/api-reference.rst:428: WARNING: Title level inconsistent:

``.have.key().being.*``
^^^^^^^^^^^^^^^^^^^^^^^
/home/tkloczko/rpmbuild/BUILD/sure-2.0.0/docs/source/api-reference.rst:481: WARNING: Title underline too short.

``callable.when.called_with(arg1, kwarg1=2).should.have.raised(Exception)``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/home/tkloczko/rpmbuild/BUILD/sure-2.0.0/docs/source/api-reference.rst:490: WARNING: Title level inconsistent:

Regular Expression matching on the exception message
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
/home/tkloczko/rpmbuild/BUILD/sure-2.0.0/docs/source/api-reference.rst:595: WARNING: Title level inconsistent:

All those possibilities below work just as the same
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
/home/tkloczko/rpmbuild/BUILD/sure-2.0.0/docs/source/api-reference.rst:610: WARNING: Title level inconsistent:

Also if you prefer using the assert keyword in your tests just go ahead an do it!
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
/home/tkloczko/rpmbuild/BUILD/sure-2.0.0/docs/source/api-reference.rst:644: WARNING: Title level inconsistent:

A note about the assert keyword
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
/home/tkloczko/rpmbuild/BUILD/sure-2.0.0/docs/source/api-reference.rst:767: WARNING: Title level inconsistent:

Holy guacamole, how did you implement that feature ?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
looking for now-outdated files... none found
pickling environment... done
checking consistency... /home/tkloczko/rpmbuild/BUILD/sure-2.0.0/docs/source/tutorial.rst: WARNING: document isn't included in any toctree
done
writing... python-sure.3 { intro getting-started how-it-works api-reference about } done
build succeeded, 12 warnings.

[kloczek]

ping 😄