Have a way of linking to the current version of a documentation page in the topnav bar

Open
#308 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
javascript
Domain
documentation

Research direction

Start at the Documentation > sunpy navbar entry and inspect how the Sphinx build supplies links for the current documentation root. Done means a page built under /en/latest links to the corresponding current documentation root rather than /en/stable.

Written by the indexing model from the issue text.

Description

Enhancement

This was originally brought up here: https://github.com/astropy/astropy-sphinx-theme/pull/48#issuecomment-3787114615

Currently we have the following situation:

  • Navigate to docs.sunpy.org/en/latest
  • Go to the Documentation > sunpy option in the top navbar
  • You are now at docs.sunpy.org/en/stable

It must be possible to have the sunpy docs sphinx build know what the root of the current documentation page is and have it substitute the link in the navbar, I just don't know how.

Dominant language
JavaScript
Stars
7
Forks
17
Avg merge
1d 13h
Merged PRs (30d)
2

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.

More from sunpy/sunpy-sphinx-theme

All issues in sunpy/sunpy-sphinx-theme

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.