Fix Sphinx warnings

doc/OnlineDocs/conf.py

@@ -68,6 +68,7 @@
     'sphinx.ext.inheritance_diagram',
     'sphinx.ext.autosummary',
     'sphinx.ext.doctest',
+    'sphinx.ext.todo',
     'sphinx_copybutton',
     #'sphinx.ext.githubpages',
 ]
@@ -121,7 +122,7 @@
 pygments_style = 'sphinx'
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
-todo_include_todos = False
+todo_include_todos = True
 
 # If true, doctest flags (comments looking like # doctest: FLAG, ...) at
 # the ends of lines and <BLANKLINE> markers are removed for all code

pyomo/contrib/appsi/solvers/highs.py

@@ -165,11 +165,13 @@ def config(self, val: HighsConfig):
     @property
     def highs_options(self):
         """
+        A dictionary mapping solver options to values for those options. These
+        are solver specific.
+
         Returns
         -------
-        highs_options: dict
-            A dictionary mapping solver options to values for those options. These
-            are solver specific.
+        dict
+           A dictionary mapping solver options to values for those options
         """
         return self._solver_options
 

pyomo/core/base/block.py

@@ -1679,10 +1679,11 @@ def block_data_objects(self,
 
         This is roughly equivalent to
 
+        .. code-block:: python
+
             iter(block for block in itertools.chain(
-                [self], self.component_data_objects(descend_into, ...))
-                if block.active == active
-            )
+                 [self], self.component_data_objects(descend_into, ...))
+                 if block.active == active)
 
         Notes
         -----

pyomo/core/plugins/transform/scaling.py

@@ -68,9 +68,7 @@ class ScaleModel(Transformation):
         >>> print(value(scaled_model.scaled_obj))
         101.0
 
-    ToDo
-    ====
-    - implement an option to change the variables names or not
+    .. todo:: Implement an option to change the variables names or not
 
     """