Skip to content

[Docs] No clickable button in other pages can return back to the Home page #7353

Description

@hwhsu1231

Problem Description

When visiting the Quickstart page of the Requests documentation, there is currently no clickable button to return to the Home page. This could be resolved if other pages (including Quickstart) featured a logo at the top of the left sidebar that links back to the home page, consistent with the Home page itself.

The cause of this behavior seems to be as follows:

First, in the html_sidebars configuration within conf.py, the top sidebar template is set to sidebarintro.html only for the index page. For all other pages, the top template is set to sidebarlogo.html:

requests/docs/conf.py

Lines 174 to 184 in ef439eb

html_sidebars = {
"index": ["sidebarintro.html", "sourcelink.html", "searchbox.html", "hacks.html"],
"**": [
"sidebarlogo.html",
"localtoc.html",
"relations.html",
"sourcelink.html",
"searchbox.html",
"hacks.html",
],
}

Currently, the hyperlinked logo is only implemented in sidebarintro.html:

<p class="logo">
<a href="{{ pathto(master_doc) }}">
<img class="logo" src="{{ pathto('_static/requests-sidebar.png', 1) }}" alt="Requests logo" />
</a>
</p>

Image

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions