Skip to content

Commit

Permalink
new doc city: remove traces of the old helpdb.jl
Browse files Browse the repository at this point in the history
  • Loading branch information
StefanKarpinski authored and MikeInnes committed Jul 31, 2015
1 parent fa4110d commit 6636796
Show file tree
Hide file tree
Showing 9 changed files with 5 additions and 13,702 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
8 changes: 2 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 @@ -96,7 +96,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 +123,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 +179,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
226 changes: 0 additions & 226 deletions base/help.jl

This file was deleted.

3 changes: 0 additions & 3 deletions base/sysimg.jl
Original file line number Diff line number Diff line change
Expand Up @@ -227,10 +227,7 @@ include("interactiveutil.jl")
include("replutil.jl")
include("test.jl")
include("i18n.jl")
include("help.jl")
using .I18n
using .Help
push!(I18n.CALLBACKS, Help.clear_cache)

# frontend
include("Terminals.jl")
Expand Down
7 changes: 1 addition & 6 deletions doc/Makefile
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Makefile for Sphinx documentation

default: helpdb.jl html
default: html

# You can set these variables from the command line.
SPHINXOPTS =
Expand Down Expand Up @@ -35,7 +35,6 @@ SPHINXBUILD = . $(ACTIVATE) && sphinx-build

help:
@echo "Please use 'make <target>' where <target> is one of"
@echo " helpdb.jl to make the REPL help db"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
Expand Down Expand Up @@ -172,10 +171,6 @@ doctest: $(SPHINX_BUILD)
@echo "Testing of doctests in the sources finished, look at the " \
"results in _build/doctest/output.txt."

helpdb.jl: stdlib/*.rst $(SPHINX_BUILD)
$(SPHINXBUILD) -b jlhelp $(ALLSPHINXOPTS) _build/jlhelp
mv _build/jlhelp/jlhelp.jl helpdb.jl

manual/unicode-input-table.rst: $(JULIAHOME)/base/latex_symbols.jl
$(JULIA_EXECUTABLE) tabcomplete.jl > manual/unicode-input-table.rst

Expand Down
2 changes: 0 additions & 2 deletions doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ Building the documentation

Build the documentation by running

$ make helpdb.jl
$ make html
$ make latexpdf

Expand All @@ -34,7 +33,6 @@ File layout
-----------

conf.py Sphinx configuration
helpdb.jl REPL help database
stdlib/ Julia standard library documentation
UNDOCUMENTED.rst Undocumented functions (to be filled in and copied to
the correct location in stdlib/)
Expand Down
Loading

0 comments on commit 6636796

Please sign in to comment.