Links to the source in the documentation

PetrKryslUCSD · June 7, 2022, 6:22pm

How does one get the links to the source to show up in the documentation?
Like this one:

PetrKryslUCSD · June 8, 2022, 2:44am

Ping. Anyone?

Benny · June 8, 2022, 2:51am

Do you mean that you’re reading documentation and for some reason the source link isn’t showing up or working? Or do you mean you’re writing documentation and need to set it up?

PetrKryslUCSD · June 8, 2022, 2:54am

Indeed, I am writing the Documenter source. I would like to have links to the documented source code
a la Julia itself, for instance. Or Gadfly, which has the ones that show up on hover.

odow · June 8, 2022, 3:07am

Do you mean the blue “source” button? Is it missing in the deployed docs? It should be automatic. Do you have a link to the bad docs?

PetrKryslUCSD · June 8, 2022, 3:10am

https://petrkryslucsd.github.io/Sparspak.jl/dev/man/functions.html#Sparspak.SpkProblem.inaij!

odow · June 8, 2022, 3:21am

Change

github.com

PetrKryslUCSD/Sparspak.jl/blob/50ecfb0d74382d16600ca69d2968e4a9da02b580/docs/make.jl#L6


      
          # using Pkg;
          # Pkg.activate()
          # Pkg.instantiate()
          
          
using Pkg
          pkg"add https://github.com/PetrKryslUCSD/Sparspak.jl.git#main"
          
          
using Documenter, Sparspak
          
          
makedocs(
          	modules = [Sparspak],
          	doctest = false, clean = true,
          	format = Documenter.HTML(prettyurls = false, assets = ["assets/custom.css"], ),
          	authors = "Petr Krysl",
          	sitename = "Sparspak.jl",
          	pages = Any[

to develop so it can find the right lines: Missing docstring source links · Issue #834 · JuliaDocs/Documenter.jl · GitHub

Alternatively, follow the documented way to setup GitHub Actions:
https://juliadocs.github.io/Documenter.jl/stable/man/hosting/#GitHub-Actions
the develop/add distinction might be too subtle.

PetrKryslUCSD · June 8, 2022, 4:52am

Thanks, mate!!!