Skip to content

Commit

Permalink
Set Sphinx option nitpicky=True
Browse files Browse the repository at this point in the history
  • Loading branch information
khaeru committed Nov 21, 2023
1 parent 13369b3 commit 3560213
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 10 deletions.
8 changes: 2 additions & 6 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,8 @@
# html_extra_path.
exclude_patterns = ["_build", "README.rst", "Thumbs.db", ".DS_Store"]

nitpick_ignore_regex = {
# These occur because there is no .. py:module:: directive for the *top-level*
# module or package in the respective documentation and inventories.
# TODO Remove once the respective docs are fixed
("py:mod", "message_ix"),
}
# Warn about *all* references where the target cannot be found
nitpicky = True

# A string of reStructuredText that will be included at the beginning of every source
# file that is read.
Expand Down
4 changes: 2 additions & 2 deletions ixmp/core/scenario.py
Original file line number Diff line number Diff line change
Expand Up @@ -353,7 +353,7 @@ def items(
If given, only iterate over items where one of the item dimensions is
`indexed_by` the set of this name.
par_data : bool, optional
If :any:`True` (the default) and `type` is :data:`.ItemType.PAR`, also
If :any:`True` (the default) and `type` is :attr:`.ItemType.PAR`, also
iterate over data for each parameter.
Yields
Expand Down Expand Up @@ -454,7 +454,7 @@ def init_item(
Parameters
----------
item_type : ItemType
item_type : .ItemType
The type of the item.
name : str
Name of the item.
Expand Down
2 changes: 1 addition & 1 deletion ixmp/model/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@


class ModelError(Exception):
"""Error in model code, e.g. :meth:`.Model.run`."""
"""Error in model code—that is, :meth:`.Model.run` or other code called by it."""


class Model(ABC):
Expand Down
2 changes: 1 addition & 1 deletion ixmp/report/util.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ def dims_for_qty(data):
If *data* is a :class:`pandas.DataFrame`, its columns are processed;
otherwise it must be a list.
:data:`RENAME_DIMS` is used to rename dimensions.
:data:`.RENAME_DIMS` is used to rename dimensions.
"""
if isinstance(data, pd.DataFrame):
# List of the dimensions
Expand Down

0 comments on commit 3560213

Please sign in to comment.