Skip to content

Display table of contents for index page in left-hand column of docs #94

@jrsmith3

Description

@jrsmith3

Overview

I am using the sphinx_rtd_theme theme for the documentation. This theme features a table of contents column on the left hand side of the page that is configured via toctree directives in the source. I would like to see the contents of the index page, but I was not able to achieve this configuration (see screenshot for an example). Apparently it is a known issue upstream: readthedocs/sphinx_rtd_theme#664.

Screenshot of ibei documentation page showing the desired location of the index page's table of contents in the left-hand sidebar.

Deliverables

  • Configure documentation source so that the table of contents of the index page is displayed in the left sidebar.

Related issues

Metadata

Metadata

Assignees

No one assigned

    Labels

    inboxIdeas and issues that require further consideration.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions