rename secondary_sidebar_items to page_sidebar_items in user guide

[MuellerSeb]

Ran into an error following the documentation for modifying secondary_sidebar_items:

preparing documents... WARNING: unsupported theme option 'secondary_sidebar_items' given

I think it should be named page_sidebar_items

[drammock]

can you check that the version of the docs you were viewing matches the version of the theme you have installed? I think secondary_sidebar_items is correct but the name change was recent; I suspect you have an older theme version installed but were viewing the development version of the docs.

[drammock]

see, e.g., here:

pydata-sphinx-theme/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/theme.conf

Lines 48 to 50 in 5133e4a

	# DEPRECATE after 0.12
	left_sidebar_end =
	page_sidebar_items =

and here:

pydata-sphinx-theme/src/pydata_sphinx_theme/__init__.py

Lines 57 to 64 in 5133e4a

	if theme_options.get("page_sidebar_items"):
	theme_options["secondary_sidebar_items"] = theme_options.get(
	"page_sidebar_items"
	)
	logger.warning(
	"The configuration `page_sidebar_items` is deprecated."
	"Use `secondary_sidebar_items`."
	)

[12rambau]

The change was done in this PR: 355fe0b. This is not yet released so I think you were looking at the latest documentation instead of stable.

[choldgraf]

@12rambau perhaps we should cut a release soon? I think that the bootstrap PR #1029 is going to be another breaking change so we probably want to cut a release before that anyway

[12rambau]

@choldgraf as I still cannot build the documentation on my weird environment, I'll leave it to you or @jarrodmillman but i'm happy to see releases whenever you see fit (these days my goal is to reduce the number of issues)

[choldgraf]

sounds good - I don't have time to cut a release for a while, but happy to review PRs from anybody else that is interested in doing so.

[MuellerSeb]

The change was done in this PR: 355fe0b. This is not yet released so I think you were looking at the latest documentation instead of stable.

You are right. That was my mistake. Sorry for the confusion.

[MuellerSeb]

But then, I think my only mistake was to follow the links in the readme, since they point to the latest release of the documentation. Going to https://pydata-sphinx-theme.readthedocs.io directly redirects to the stable version. Is that intended?

[12rambau]

@MuellerSeb Nice catch, to my understanding it's not intended, it would be safer to remove "latest" from the link. would you mind doing a patch PR ?