apple / apple/pfl-research

Add "source" button in documentation to view code

Open
#83 0 comments 0 reactions 0 assignees View on GitHub
Beginner issue
Dominant language
Jupyter Notebook
Stars
358
Forks
43
Avg merge
9h 2m
Merged PRs (30d)
2

Description

The reference documentation https://apple.github.io/pfl-research/ should have links to source code for each component. Useful for navigation and to more effectively copy implemented algorithms and customize them for research.
We use Furo frontend sphinx theme https://github.com/pradyunsg/furo.

(65729691)

Contributor guide

Open the contributing guide

Research direction

Start with the Sphinx documentation configuration for the reference site and review how the Furo theme exposes source links. Verify the result on the published documentation so each component has a usable link to its source code.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.