pydata/pydata-sphinx-theme

How do you use the right "Edit in Github" url for generated files?

Open

#1,269 opened on Mar 26, 2023

View on GitHub
 (13 comments) (0 reactions) (0 assignees)Python (376 forks)github user discovery
help wantedkind: enhancementtag: component

Repository metrics

Stars
 (766 stars)
PR merge metrics
 (Avg merge 1d 14h) (18 merged PRs in 30d)

Description

Discussed in https://github.com/pydata/pydata-sphinx-theme/discussions/1266

Originally posted by vnmabus March 24, 2023 For generated files, such as examples generated with sphinx-gallery or API reference pages generated with autosummary, the "Edit in Github" link generates a 404 error.

It is possible to redirect them to the original file somehow? In that case, how?

Contributor guide

Research direction
Investigate how Sphinx gallery and autosummary generate file paths and modify the theme's template to use the correct source URL instead of the generated file URL.
Tech stack
python
Domain
documentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
PythonSphinx
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60