Skip to content

Commit bc17cec

Browse files
Merge pull request #11943 from JuliaLang/omm/doc-transition-2
Doc hard, and with a vengeance
2 parents 2ef1362 + b980d09 commit bc17cec

33 files changed

+20969
-13766
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ Make sure that [Travis](http://www.travis-ci.org) greenlights the pull request w
154154
- Try to [squash](http://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.
155155
- 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.
156156
- If you see any unrelated changes to submodules like `deps/libuv`, `deps/openlibm`, etc., try running `git submodule update` first.
157-
- 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.
157+
- 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.
158158
- Descriptive commit messages are good.
159159
- Using `git add -p` or `git add -i` can be useful to avoid accidentally committing unrelated changes.
160160
- 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.

Makefile

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ endif
4848
julia-deps: | $(DIRS) $(build_datarootdir)/julia/base $(build_datarootdir)/julia/test $(build_docdir) $(build_sysconfdir)/julia/juliarc.jl $(build_man1dir)/julia.1
4949
@$(MAKE) $(QUIET_MAKE) -C deps
5050

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

5454
julia-libccalltest:
@@ -82,6 +82,7 @@ endif
8282

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

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

127-
$(build_docdir)/helpdb.jl: doc/helpdb.jl | $(build_docdir)
128-
@cp $< $@
129-
130127
$(build_man1dir)/julia.1: doc/man/julia.1 | $(build_man1dir)
131128
@mkdir -p $(build_man1dir)
132129
@cp $< $@
@@ -183,7 +180,7 @@ $(build_private_libdir)/inference.ji: $(build_private_libdir)/inference0.ji
183180

184181
COMMA:=,
185182
define sysimg_builder
186-
$$(build_private_libdir)/sys$1.o: $$(build_private_libdir)/inference.ji VERSION $$(BASE_SRCS) $$(build_docdir)/helpdb.jl
183+
$$(build_private_libdir)/sys$1.o: $$(build_private_libdir)/inference.ji VERSION $$(BASE_SRCS)
187184
@$$(call PRINT_JULIA, cd base && \
188185
$$(call spawn,$2) -C $$(JULIA_CPU_TARGET) --output-o $$(call cygpath_w,$$@) $$(JULIA_SYSIMG_BUILD_FLAGS) -f \
189186
-J $$(call cygpath_w,$$<) sysimg.jl \

base/docs/Docs.jl

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -527,10 +527,7 @@ macro repl(ex)
527527
if $(isfield(ex) ? :(isa($(esc(ex.args[1])), DataType)) : false)
528528
$(isfield(ex) ? :(fielddoc($(esc(ex.args[1])), $(ex.args[2]))) : nothing)
529529
else
530-
# Backwards-compatible with the previous help system, for now
531-
let doc = @doc $(esc(ex))
532-
doc nothing ? doc : Base.Help.@help_ $(esc(ex))
533-
end
530+
@doc $(esc(ex))
534531
end
535532
end
536533
end

base/docs/basedocs.jl

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,6 @@ const intro = doc"""
1616
For help on a specific function or macro, type `?` followed
1717
by its name, e.g. `?fft`, `?@time` or `?html`, and press
1818
enter.
19-
20-
You can also use `apropos("...")` to search the documentation.
2119
"""
2220

2321
keywords[:help] = keywords[:?] = keywords[:julia] = keywords[:wtf] = intro

0 commit comments

Comments
 (0)