You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Sometimes you need to detect who is building the docs. For example, for Literate.jl I want to predict URLs to the final output. On Travis this is easy; I detect that code is running on Travis, and use TRAVIS_REPO_SLUG to guess a GitHub URL, and similar for embedding links to nbviewer.org for generated notebook files, see e.g. @__REPO__ROOT_URL__ from https://fredrikekre.github.io/Literate.jl/stable/fileformat/#Default-Replacements-1
I think what I need from DocumentationGenerator is the following:
Some way to detect that docs are being built by DocumentationGenerator e.g. DOCUMENTATIONGENERATOR="true"
Some environment variable for the final base URL where the docs will be deployed, e.g. DOCUMENTATIONGENERATOR_BASEURL="pkg.julialang.org/docs/Literate/XPnWG/1.1.0/" so that I can query where the docs currently beeing built will be deployed.
The text was updated successfully, but these errors were encountered:
Sometimes you need to detect who is building the docs. For example, for Literate.jl I want to predict URLs to the final output. On Travis this is easy; I detect that code is running on Travis, and use
TRAVIS_REPO_SLUG
to guess a GitHub URL, and similar for embedding links to nbviewer.org for generated notebook files, see e.g.@__REPO__ROOT_URL__
from https://fredrikekre.github.io/Literate.jl/stable/fileformat/#Default-Replacements-1The problem now is that the docs built by DocumentationGenerator have wrong links, since its not beeing built on Travis, compare e.g. the
show nbviewer
links here https://fredrikekre.github.io/Literate.jl/stable/generated/example/ and here https://pkg.julialang.org/docs/Literate/XPnWG/1.1.0/generated/example/I think what I need from DocumentationGenerator is the following:
DOCUMENTATIONGENERATOR="true"
DOCUMENTATIONGENERATOR_BASEURL="pkg.julialang.org/docs/Literate/XPnWG/1.1.0/"
so that I can query where the docs currently beeing built will be deployed.The text was updated successfully, but these errors were encountered: