matplotlib / matplotlib/mpl-sphinx-theme

Have logo link default to current index

Open
#81 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement navbar
Dominant language
Python
Stars
6
Forks
13
PR merge metrics
No merged PRs in 30d

Description

Because one of the primary ways to navigate to the index is via logo, the default link for the logo being matplotlib.org/stable gets really frustrating when editing the landing page.

https://github.com/story645/mpl-sphinx-theme/blob/6d13c7b1c1ed722d63d08697cd48278a9615acc4/mpl_sphinx_theme/__init__.py#L21-L22

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open mpl_sphinx_theme/init.py at lines 21–22 and inspect how the logo link is configured. Update the default so the logo points to the current documentation index instead of matplotlib.org/stable, then verify that navigation from the landing page reaches the current index.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.