Skip to content

Commit

Permalink
Merge pull request #11943 from JuliaLang/omm/doc-transition-2
Browse files Browse the repository at this point in the history
Doc hard, and with a vengeance
  • Loading branch information
StefanKarpinski committed Aug 2, 2015
2 parents 2ef1362 + b980d09 commit bc17cec
Show file tree
Hide file tree
Showing 33 changed files with 20,969 additions and 13,766 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ Make sure that [Travis](http:https://www.travis-ci.org) greenlights the pull request w
- Try to [squash](http:https://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html) together small commits that make repeated changes to the same section of code so your pull request is easier to review, and Julia's history won't have any broken intermediate commits. A reasonable number of separate well-factored commits is fine, especially for larger changes.
- If any conflicts arise due to changes in Julia's `master`, prefer updating your pull request branch with `git rebase` versus `git merge` or `git pull`, since the latter will introduce merge commits that clutter the git history with noise that makes your changes more difficult to review.
- If you see any unrelated changes to submodules like `deps/libuv`, `deps/openlibm`, etc., try running `git submodule update` first.
- Avoid committing changes to auto-generated files such as `doc/helpdb.jl`, which is a frequent source of conflicts and can be re-generated later.
- Avoid committing changes to auto-generated files such as `doc/stdlib/*.rst`, which is a frequent source of conflicts and can be re-generated later.
- Descriptive commit messages are good.
- Using `git add -p` or `git add -i` can be useful to avoid accidentally committing unrelated changes.
- GitHub does not send notifications when you push a new commit to a pull request, so please add a comment to the pull request thread to let reviewers know when you've made changes.
Expand Down
9 changes: 3 additions & 6 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ endif
julia-deps: | $(DIRS) $(build_datarootdir)/julia/base $(build_datarootdir)/julia/test $(build_docdir) $(build_sysconfdir)/julia/juliarc.jl $(build_man1dir)/julia.1
@$(MAKE) $(QUIET_MAKE) -C deps

julia-base: julia-deps $(build_docdir)/helpdb.jl
julia-base: julia-deps
@$(MAKE) $(QUIET_MAKE) -C base

julia-libccalltest:
Expand Down Expand Up @@ -82,6 +82,7 @@ endif

release-candidate: release testall
@$(JULIA_EXECUTABLE) contrib/add_license_to_files.jl #add license headers
@$(JULIA_EXECUTABLE) doc/genstdlib.jl
@#Check documentation
@$(JULIA_EXECUTABLE) doc/NEWS-update.jl #Add missing cross-references to NEWS.md
@$(MAKE) -C doc unicode #Rebuild Unicode table if necessary
Expand All @@ -96,7 +97,6 @@ release-candidate: release testall
@$(MAKE) -C doc latex SPHINXOPTS="-n" #Rebuild Julia PDF docs pedantically
@$(MAKE) -C doc doctest #Run Julia doctests
@$(MAKE) -C doc linkcheck #Check all links
@$(MAKE) -C doc helpdb.jl #Rebuild Julia online documentation for help(), apropos(), etc...

@# Check to see if the above make invocations changed anything important
@if [ -n "$$(git status --porcelain)" ]; then \
Expand Down Expand Up @@ -124,9 +124,6 @@ release-candidate: release testall
@echo 10. Change master to release-0.X in base/version.jl and base/version_git.sh as in 4cb1e20
@echo

$(build_docdir)/helpdb.jl: doc/helpdb.jl | $(build_docdir)
@cp $< $@

$(build_man1dir)/julia.1: doc/man/julia.1 | $(build_man1dir)
@mkdir -p $(build_man1dir)
@cp $< $@
Expand Down Expand Up @@ -183,7 +180,7 @@ $(build_private_libdir)/inference.ji: $(build_private_libdir)/inference0.ji

COMMA:=,
define sysimg_builder
$$(build_private_libdir)/sys$1.o: $$(build_private_libdir)/inference.ji VERSION $$(BASE_SRCS) $$(build_docdir)/helpdb.jl
$$(build_private_libdir)/sys$1.o: $$(build_private_libdir)/inference.ji VERSION $$(BASE_SRCS)
@$$(call PRINT_JULIA, cd base && \
$$(call spawn,$2) -C $$(JULIA_CPU_TARGET) --output-o $$(call cygpath_w,$$@) $$(JULIA_SYSIMG_BUILD_FLAGS) -f \
-J $$(call cygpath_w,$$<) sysimg.jl \
Expand Down
5 changes: 1 addition & 4 deletions base/docs/Docs.jl
Original file line number Diff line number Diff line change
Expand Up @@ -527,10 +527,7 @@ macro repl(ex)
if $(isfield(ex) ? :(isa($(esc(ex.args[1])), DataType)) : false)
$(isfield(ex) ? :(fielddoc($(esc(ex.args[1])), $(ex.args[2]))) : nothing)
else
# Backwards-compatible with the previous help system, for now
let doc = @doc $(esc(ex))
doc nothing ? doc : Base.Help.@help_ $(esc(ex))
end
@doc $(esc(ex))
end
end
end
Expand Down
2 changes: 0 additions & 2 deletions base/docs/basedocs.jl
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,6 @@ const intro = doc"""
For help on a specific function or macro, type `?` followed
by its name, e.g. `?fft`, `?@time` or `?html`, and press
enter.
You can also use `apropos("...")` to search the documentation.
"""

keywords[:help] = keywords[:?] = keywords[:julia] = keywords[:wtf] = intro
Expand Down
Loading

0 comments on commit bc17cec

Please sign in to comment.