🧪 CI: Make documentation builds fail on warnings

.readthedocs.yml

@@ -2,6 +2,8 @@ version: 2
 
 sphinx:
   configuration: docs/conf.py
+  builder: html
+  fail_on_warning: true
 
 python:
   install:

docs/changelog.rst

@@ -15,13 +15,11 @@ Released: under development
 1.4.0
 -----
 Released: under development
+
 * Improvement: Added Builder :ref:`needs_id_builder` added and config option :ref:`needs_build_json_per_id` in `conf.py`. 
-* Improvement: Reduce document build time, by memoizing the inline parse in ``build_need``
-  (`#968 <https://github.com/useblocks/sphinx-needs/pull/968>`_)
-* Change `NeedsBuilder` format to `needs`
-  (`#978 <https://github.com/useblocks/sphinx-needs/pull/978>`_)
-* Improvement: Suffix all warnings with ``[needs]``, and allow them to be suppressed
-  (`#975 <https://github.com/useblocks/sphinx-needs/pull/975>`_)
+* Improvement: Reduce document build time, by memoizing the inline parse in ``build_need`` (`#968 <https://github.com/useblocks/sphinx-needs/pull/968>`_)
+* Change `NeedsBuilder` format to `needs` (`#978 <https://github.com/useblocks/sphinx-needs/pull/978>`_)
+* Improvement: Suffix all warnings with ``[needs]``, and allow them to be suppressed (`#975 <https://github.com/useblocks/sphinx-needs/pull/975>`_)
 * Improvement: :ref:`needextend` for single needs is much faster.
 * Improvement: external_needs is using cached templates to save generation time.
 

docs/conf.py

@@ -62,6 +62,13 @@
     "sphinx": ("https://www.sphinx-doc.org/en/master", None),
 }
 
+nitpicky = True
+nitpick_ignore = [
+    ("py:class", "T"),
+    ("py:class", "sphinx_needs.debug.T"),
+    ("py:class", "sphinx_needs.data.NeedsInfoType"),
+]
+
 # smartquotes = False
 
 needs_debug_measurement = True

docs/requirements.txt

@@ -7,4 +7,4 @@ sphinxcontrib-programoutput
 sphinx-design
 click
 tabulate
-sphinx-immaterial==0.11.6
+sphinx-immaterial==0.11.7

sphinx_needs/debug.py

@@ -50,7 +50,6 @@ def my_cool_function(a, b,c ):
     :param category: Name of a category, which helps to cluster the measured functions.
     :param source: Should be "internal" or "user". Used to easily structure function written by user.
     :param name: Name to use for the measured. If not given, the function name is used.
-    :param func: Can contain a func, which shall get decorated. Not used if ``measure_time`` is used as decorator.
     """
 
     def inner(func: T) -> T: