Skip to content

rename secondary_sidebar_items to page_sidebar_items in user guide #1028

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.

Sign up for GitHub

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

Closed
wants to merge 1 commit into from
Closed

rename secondary_sidebar_items to page_sidebar_items in user guide #1028

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/user_guide/layout.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -368,15 +368,15 @@ Secondary Sidebar (right)
=========================

The in-page sidebar is just to the right of a page's article content, and is
configured in ``conf.py`` with ``html_theme_options['secondary_sidebar_items']``.
configured in ``conf.py`` with ``html_theme_options['page_sidebar_items']``.

By default, it has the following templates:

.. code-block:: python

html_theme_options = {
...
"secondary_sidebar_items": ["page-toc", "edit-this-page", "sourcelink"],
"page_sidebar_items": ["page-toc", "edit-this-page", "sourcelink"],
...
}

Expand Down