-
Notifications
You must be signed in to change notification settings - Fork 45
fix sphinx warnings and errors #588
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix sphinx warnings and errors #588
Conversation
| second_node_nonant_name_at_node, | ||
| ... | ||
| ] | ||
| .. code-block:: python |
There was a problem hiding this comment.
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): |
There was a problem hiding this comment.
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.
| .. NOTE:: | ||
| These types of variables are often indicator variables |
There was a problem hiding this comment.
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
left a comment
There was a problem hiding this 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)
Gern geschehen. |
[x] fixes #587
I was not able to solve all warnings. See:
I was not able to find a chapter with the name "Pickled bundles" and need a hint, how to solve this issue.
mpi-sppy/doc/src/agnostic.rst
Line 228 in d2ba884
mpi-sppy/doc/src/agnostic.rst
Line 274 in d2ba884