Skip to content

Conversation

@mosc9575
Copy link
Contributor

@mosc9575 mosc9575 commented Nov 27, 2025

[x] fixes #587

I was not able to solve all warnings. See:

\mpi-sppy\doc\src\agnostic.rst:222: WARNING: undefined label: 'pickled-bundles'
\mpi-sppy\doc\src\agnostic.rst:274: WARNING: undefined label: 'pickled-bundles'

I was not able to find a chapter with the name "Pickled bundles" and need a hint, how to solve this issue.

described in section :ref:`Pickled-Bundles`.

is what is done in (non-agnostic) :ref:`Pickled-Bundles`. The result of this

second_node_nonant_name_at_node,
...
]
.. code-block:: python
Copy link
Contributor Author

@mosc9575 mosc9575 Nov 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I used the text highlighting for python, because of the use of variables. This looks quite good and the selection "JSON" for text highlighting was broken. I think this is a good compromise.

logger = logging.getLogger('mpisppy.scenario_tree')
logger = logging.getLogger("mpisppy.scenario_tree")

def build_vardatalist(self, model, varlist=None):
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed this code, because it is not used in the repo and is a (broken) copy of the sputils.build_vardatalist. The argument self irritates and can cause errors. Therefor it is good to delete this duplication and avoid confusion.

Comment on lines +38 to +40
.. NOTE::
These types of variables are often indicator variables
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This adds a "note"-directive. The empty line is not needed. IMHO this improves readability.

@DLWoodruff DLWoodruff self-requested a review December 1, 2025 02:37
Copy link
Collaborator

@DLWoodruff DLWoodruff left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Danke sehr. I add the two bad links to my todo list (but might not get to it this week)

@DLWoodruff DLWoodruff merged commit 6dad9e8 into Pyomo:main Dec 1, 2025
19 checks passed
@mosc9575
Copy link
Contributor Author

mosc9575 commented Dec 1, 2025

Danke sehr.

Gern geschehen.

@mosc9575 mosc9575 deleted the 587_fix_sphinx_warnings_and_errors branch December 1, 2025 09:19
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

Successfully merging this pull request may close these issues.

Fix warnings and errors while building the documentation with sphinx

2 participants