Skip to content

doc: Get stdlib dir from make system rather than executable #58530

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 27, 2025
Merged

doc: Get stdlib dir from make system rather than executable #58530

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions doc/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ help:
@echo "To fix outdated doctests, use 'make <target> doctest=fix'"
@echo "To run doctests using Revise (to test changes without rebuilding the sysimage), use 'make <target> doctest=true revise=true'"


VERSDIR := v`cut -d. -f1-2 < $(JULIAHOME)/VERSION`
DOCUMENTER_OPTIONS := linkcheck=$(linkcheck) doctest=$(doctest) buildroot=$(call cygpath_w,$(BUILDROOT)) \
texplatform=$(texplatform) revise=$(revise)
texplatform=$(texplatform) revise=$(revise) stdlibdir=$(call cygpath_w,$(build_datarootdir)/julia/stdlib/$(VERSDIR)/)

UNICODE_DATA_VERSION=13.0.0
$(SRCCACHE)/UnicodeData-$(UNICODE_DATA_VERSION).txt:
Expand Down
22 changes: 20 additions & 2 deletions doc/make.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,24 @@
# Get the buildroot and stdlibdir from the make environment to make sure we're
# generating docs for the current julia source tree, regardless of what julia
# executable we're using. If these arguments are not passed, fall back to
# assuming that we're running a just-built version of julia and generating docs
# in tree.
let r = r"buildroot=(.+)", i = findfirst(x -> occursin(r, x), ARGS)
global const buildrootdoc = i === nothing ? (@__DIR__) : joinpath(first(match(r, ARGS[i]).captures), "doc")
if i === nothing
global const buildrootdoc = @__DIR__
global const buildroot = abspath(joinpath(buildrootdoc, ".."))
else
global const buildroot = first(match(r, ARGS[i]).captures)
global const buildrootdoc = joinpath(buildroot, "doc")
end
end

let r = r"stdlibdir=(.+)", i = findfirst(x -> occursin(r, x), ARGS)
if i === nothing
global const STDLIB_DIR = Sys.STDLIB
else
global const STDLIB_DIR = first(match(r, ARGS[i]).captures)
end
end

# Install dependencies needed to build the documentation.
Expand Down Expand Up @@ -28,7 +47,6 @@ cp_q(src, dest) = isfile(dest) || cp(src, dest)

# make links for stdlib package docs, this is needed until #552 in Documenter.jl is finished
const STDLIB_DOCS = []
const STDLIB_DIR = Sys.STDLIB
const EXT_STDLIB_DOCS = ["Pkg"]
cd(joinpath(buildrootdoc, "src")) do
Base.rm("stdlib"; recursive=true, force=true)
Expand Down