JuliaDocs/Documenter.jl

Allow anchor linking to specific docs of a method

Open

#1,434 opened on Oct 11, 2020

View on GitHub
 (0 comments) (2 reactions) (0 assignees)Julia (513 forks)batch import
Format: HTMLType: Enhancementhelp wanted

Repository metrics

Stars
 (910 stars)
PR merge metrics
 (Avg merge 16d 9h) (3 merged PRs in 30d)

Description

For example, addprocs (Distributed Computing) has a lot of different methods. It would be nice if we could link to a specific one directly via an HTML anchor.

The anchors could looke like (for addprocs):

  • #Distributed-Computing-addprocs-1
  • #Distributed-Computing-addprocs-2
  • #Distributed-Computing-addprocs-3

or, more generically:

  • #<section>-<methodname>-<count>

Contributor guide

Research direction
Investigate how Documenter.jl generates anchors for function signatures currently. Then modify the HTML generation to include unique anchors per method based on section and method count.
Tech stack
julia
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.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Julia
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65