doc: create rules overview for SB and CBA rules

[tgilon]

Closes # (if applicable).

Changes proposed in this Pull Request

Extends #759 and follow-up of #754. This PR creates rules overview for all SB and CBA rules. This PR also suggests to disable root TOC entries in order to declutter the table of contents for the rules overview (contributed upstream in PyPSA#2216).

Preview of the changes: https://open-tyndp--761.org.readthedocs.build/en/761/sb_rules/

Tasks

Workflow

Open issues

Notes

Generative AI was used to assist with code generation and review. All content has been reviewed, verified, and is the responsibility of the author.

Checklist

• Security scan(s) show no high-severity bugs, critical vulnerabilities, or exposed secrets.
• I tested my contribution locally and it works as intended.
• Code and workflow changes are sufficiently documented.
• Changed dependencies are added to pixi.toml (using pixi add <dependency-name>).
• Changes in configuration options are added in config/config.default.yaml.
• Changes in configuration options are documented in doc/configtables/*.csv.
• Changes in configuration options are added in config/test/*.yaml.
• The multiple weather/climate years test is passing locally (using pixi run -e open-tyndp tyndp-cyears-test).
• Open-TYNDP SPDX license header added to all touched files.
• For new data sources or versions, these instructions have been followed.
• New rules are documented in the appropriate doc/*.rst files.
• A release note doc/release_notes.rst is added.
• Major features are documented with up-to-date information in doc/index.rst.
• Module docstrings added to new Python scripts.

[lisazeyen]

Great, thanks a lot @tgilon for preparing!

I mainly have comments about the grouping of the rules and made some suggestions plus two minor comments (typo + missing returns in a function).

[lisazeyen]

it is just about the docstring of this function def solve_network it seems to remove the description on Returns

[tgilon]

I don't see any diff with master (see master code here).

open-tyndp/scripts/cba/solve_cba_network.py

Lines 203 to 235 in f4e1207

	def solve_network(
	n: pypsa.Network,
	config: dict,
	params: dict,
	solving: dict,
	planning_horizons: str | None = None,
	**kwargs,
	) -> None:
	"""
	Solve network optimization problem.
	Parameters
	----------
	n : pypsa.Network
	The PyPSA network instance.
	config : dict
	Configuration dictionary containing solver settings.
	params : dict
	Dictionary of solving parameters.
	solving : dict
	Dictionary of solving options and configuration.
	planning_horizons : str or None, optional
	The current planning horizon year or None in perfect foresight.
	**kwargs
	Additional keyword arguments passed to the solver.
	Raises
	------
	RuntimeError
	If solving status is infeasible or warning
	ObjectiveValueError
	If objective value differs from expected value
	"""

Either way, the function does not return anything, so I don't think it's useful to document it in the docstring. Do you agree?

[lisazeyen]

@tgilon thanks for preparing the PR! I agree with your suggestion for the rule grouping. There is just one minor comment about a docstring where I think the description for the return values is getting lost (but maybe this is intentional). Good to go from my side!