Skip to content

Commit

Permalink
Deploy docs with clean URLs (#22048)
Browse files Browse the repository at this point in the history
* Move deps .PHONY together with others

* Remove duplicate page from manual

The "Interacting with Julia" page was listed twice in the sidebar.

* Build docs with clean URLs

Documenter has to be bumped to v0.11.1 for this. Also change two
absolute URLs that will become outdated with this change to the more
appropriate relative URLs.

Also bump Compat to get rid of deprecation warnings.

* Remove duplicate symm docstring reference

There is only one 5-argument docstring:

  symm(side, ul, alpha, A, B)
  • Loading branch information
mortenpi authored and tkelman committed Jun 3, 2017
1 parent a692b2a commit 9a22471
Show file tree
Hide file tree
Showing 6 changed files with 15 additions and 10 deletions.
2 changes: 2 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -147,3 +147,5 @@ script:
rm -f julia/deps/scratch/libgit2-*/CMakeFiles/CMakeOutput.log
# uncomment the following if failures are suspected to be due to the out-of-memory killer
# - dmesg
after_success:
- cd julia && make -C doc deploy
12 changes: 8 additions & 4 deletions doc/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ JULIAHOME := $(abspath $(SRCDIR)/..)
include $(JULIAHOME)/Make.inc
JULIA_EXECUTABLE := $(call spawn,$(build_bindir)/julia)

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

help:
@echo "Please use 'make <target>' where <target> is one of"
Expand All @@ -32,10 +32,10 @@ cleanall: clean
html: deps
@echo "Building HTML documentation."
ifneq ($(OS),WINNT)
$(JULIA_EXECUTABLE) $(call cygpath_w,$(SRCDIR)/make.jl) -- deploy
$(JULIA_EXECUTABLE) $(call cygpath_w,$(SRCDIR)/make.jl)
else
# work around issue #11727, windows output redirection breaking on buildbot
$(JULIA_EXECUTABLE) $(call cygpath_w,$(SRCDIR)/make.jl) -- deploy > docbuild.log 2>&1
$(JULIA_EXECUTABLE) $(call cygpath_w,$(SRCDIR)/make.jl) > docbuild.log 2>&1
@cat docbuild.log
endif
@echo "Build finished. The HTML pages are in _build/html."
Expand All @@ -60,4 +60,8 @@ check: deps
$(JULIA_EXECUTABLE) --color=yes $(call cygpath_w,$(SRCDIR)/make.jl) -- doctest linkcheck
@echo "Checks finished."

.PHONY: deps
# The deploy target should only be called in Travis builds
deploy: deps
@echo "Deploying HTML documentation."
$(JULIA_EXECUTABLE) $(call cygpath_w,$(SRCDIR)/make.jl) -- deploy
@echo "Build & deploy of docs finished."
4 changes: 2 additions & 2 deletions doc/REQUIRE
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Compat 0.25.0 0.25.0+
Compat 0.25.2 0.25.2+
DocStringExtensions 0.3.3 0.3.3+
Documenter 0.10.3 0.10.3+
Documenter 0.11.1 0.11.1+
2 changes: 1 addition & 1 deletion doc/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,6 @@ const PAGES = [
"manual/calling-c-and-fortran-code.md",
"manual/handling-operating-system-variation.md",
"manual/environment-variables.md",
"manual/interacting-with-julia.md",
"manual/embedding.md",
"manual/packages.md",
"manual/profile.md",
Expand Down Expand Up @@ -130,6 +129,7 @@ makedocs(
authors = "The Julia Project",
analytics = "UA-28835595-6",
pages = PAGES,
html_prettyurls = ("deploy" in ARGS),
)

if "deploy" in ARGS
Expand Down
4 changes: 2 additions & 2 deletions doc/src/manual/dates.md
Original file line number Diff line number Diff line change
Expand Up @@ -561,7 +561,7 @@ julia> round(DateTime(2016, 8, 6, 20, 15), Dates.Day)
Unlike the numeric [`round()`](@ref) method, which breaks ties toward the even number by default,
the [`TimeType`](@ref)[`round()`](@ref) method uses the `RoundNearestTiesUp` rounding mode. (It's
difficult to guess what breaking ties to nearest "even" [`TimeType`](@ref) would entail.) Further
details on the available `RoundingMode` s can be found in the [API reference](https://docs.julialang.org/en/latest/stdlib/dates.html).
details on the available `RoundingMode` s can be found in the [API reference](../stdlib/dates.md).

Rounding should generally behave as expected, but there are a few cases in which the expected
behaviour is not obvious.
Expand Down Expand Up @@ -626,5 +626,5 @@ will result in the months field having an odd value. Because both months and yea
an irregular number of days, whether rounding to an even number of days will result in an even
value in the days field is uncertain.

See the [API reference](https://docs.julialang.org/en/latest/stdlib/dates.html) for additional information
See the [API reference](../stdlib/dates.md) for additional information
on methods exported from the `Dates` module.
1 change: 0 additions & 1 deletion doc/src/stdlib/linalg.md
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,6 @@ Base.LinAlg.BLAS.gemv(::Any, ::Any, ::Any)
Base.LinAlg.BLAS.symm!
Base.LinAlg.BLAS.symm(::Any, ::Any, ::Any, ::Any, ::Any)
Base.LinAlg.BLAS.symm(::Any, ::Any, ::Any, ::Any)
Base.LinAlg.BLAS.symm(::Char, ::Char, ::Any, ::Any, ::Any)
Base.LinAlg.BLAS.symv!
Base.LinAlg.BLAS.symv(::Any, ::Any, ::Any, ::Any)
Base.LinAlg.BLAS.symv(::Any, ::Any, ::Any)
Expand Down

2 comments on commit 9a22471

@nanosoldier
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Executing the daily benchmark build, I will reply here when finished:

@nanosoldier runbenchmarks(ALL, isdaily = true)

@nanosoldier
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Your benchmark job has completed - possible performance regressions were detected. A full report can be found here. cc @jrevels

Please sign in to comment.