Skip to content
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

Jump to bottom

Upgrade Documenter, and add make target to fix doctests #26515

Merged
merged 2 commits into from
Mar 20, 2018
Merged

Upgrade Documenter, and add make target to fix doctests #26515

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
043365b
upgrade Documenter to v0.15.0
fredrikekre Mar 19, 2018
63186c4
add make target to fix all (outdated) doctests:
fredrikekre Mar 19, 2018
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
Prev Previous commit
add make target to fix all (outdated) doctests: 
    make -C doc doctest-fix
  • Loading branch information
@fredrikekre
fredrikekre committed Mar 19, 2018
commit 63186c435586fba4f304875031da8444c28e861d
18 changes: 12 additions & 6 deletions doc/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,16 @@ JULIAHOME := $(abspath $(SRCDIR)/..)
include $(JULIAHOME)/Make.inc
JULIA_EXECUTABLE := $(call spawn,$(build_bindir)/julia)

.PHONY: help clean cleanall html pdf linkcheck doctest check deps deploy
.PHONY: help clean cleanall html pdf linkcheck doctest doctest-fix check deps deploy

help:
@echo "Please use 'make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " pdf to make standalone PDF file"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation"
@echo " check to run linkcheck and doctests"
@echo " html to make standalone HTML files"
@echo " pdf to make standalone PDF file"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation"
@echo " doctest-fix to update all doctests embedded in the documentation"
@echo " check to run linkcheck and doctests"

UnicodeData.txt:
$(JLDOWNLOAD) http:https://www.unicode.org/Public/9.0.0/ucd/UnicodeData.txt
Expand Down Expand Up @@ -55,6 +56,11 @@ doctest: deps
$(JULIA_EXECUTABLE) --color=yes $(call cygpath_w,$(SRCDIR)/make.jl) -- doctest
@echo "Checks finished."

doctest-fix: deps
@echo "Updating all embedded 'doctests'."
$(JULIA_EXECUTABLE) --color=yes $(call cygpath_w,$(SRCDIR)/make.jl) -- doctest-fix
@echo "Update finished."

check: deps
@echo "Running all embedded 'doctests' and checking external links."
$(JULIA_EXECUTABLE) --color=yes $(call cygpath_w,$(SRCDIR)/make.jl) -- doctest linkcheck
Expand Down
2 changes: 1 addition & 1 deletion doc/make.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ makedocs(
build = joinpath(@__DIR__, "_build/html/en"),
modules = [Base, Core, BuildSysImg, [Base.root_module(Base, stdlib.stdlib) for stdlib in STDLIB_DOCS]...],
clean = true,
doctest = "doctest" in ARGS,
doctest = ("doctest-fix" in ARGS) ? (:fix) : ("doctest" in ARGS),
linkcheck = "linkcheck" in ARGS,
linkcheck_ignore = ["https://bugs.kde.org/show_bug.cgi?id=136779"], # fails to load from nanosoldier?
strict = false,
Expand Down