new doc city: delete old helpdb.jl and things that depends on it

JuliaLang · Jun 27, 2015 · cf2c4ff · cf2c4ff
1 parent 52315cb
commit cf2c4ff
Show file tree

Hide file tree

Showing 10 changed files with 4 additions and 13,570 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -144,7 +144,7 @@ Make sure that [Travis](http://www.travis-ci.org) greenlights the pull request w
  - 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.
  - 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.

diff --git a/Makefile b/Makefile
@@ -89,7 +89,6 @@ release-candidate: release test
 	@$(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 \
@@ -117,9 +116,6 @@ release-candidate: release test
 	@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 $< $@
@@ -188,7 +184,7 @@ JULIA_SYSIMG_BUILD_FLAGS += --output-ji $(call cygpath_w,$(build_private_libdir)
 endif
 
 COMMA:=,
-$(build_private_libdir)/sys.o: VERSION $(BASE_SRCS) $(build_docdir)/helpdb.jl $(build_private_libdir)/inference.$(SHLIB_EXT)
+$(build_private_libdir)/sys.o: VERSION $(BASE_SRCS) $(build_private_libdir)/inference.$(SHLIB_EXT)
 	@$(call PRINT_JULIA, cd base && \
 	$(call spawn,$(JULIA_EXECUTABLE)) -C $(JULIA_CPU_TARGET) --output-o $(call cygpath_w,$(build_private_libdir)/sys.o) $(JULIA_SYSIMG_BUILD_FLAGS) -f \
 		-J $(call cygpath_w,$(build_private_libdir)/inference.$(SHLIB_EXT)) sysimg.jl \

diff --git a/base/docs/Docs.jl b/base/docs/Docs.jl
@@ -386,10 +386,7 @@ macro repl (ex)
                   haskey(keywords, $(Expr(:quote, ex))))
             repl_corrections($(string(ex)))
         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

diff --git a/base/docs/helpdb.jl b/base/docs/helpdb.jl
@@ -1673,22 +1673,6 @@
   ```
   """ include_string
 
-  @doc doc"""
-  ```rst
-  help(name)
-
-   Get help for a function. "name" can be an object or a string.
-  ```
-  """ help
-
-  @doc doc"""
-  ```rst
-  apropos(string)
-
-   Search documentation for functions related to "string".
-  ```
-  """ apropos
-
   @doc doc"""
   ```rst
   which(f, types)

diff --git a/base/help.jl b/base/help.jl
diff --git a/base/sysimg.jl b/base/sysimg.jl
@@ -231,10 +231,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")

diff --git a/doc/Makefile b/doc/Makefile
@@ -1,6 +1,6 @@
 # Makefile for Sphinx documentation
 
-default: helpdb.jl html
+default: html
 
 # You can set these variables from the command line.
 SPHINXOPTS    =
@@ -34,7 +34,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"
@@ -171,10 +170,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
 	$(JULIAHOME)/julia tabcomplete.jl > manual/unicode-input-table.rst
 

diff --git a/doc/README.md b/doc/README.md
@@ -25,7 +25,6 @@ Building the documentation
 
 Build the documentation by running
 
-    $ make helpdb.jl
     $ make html
     $ make latexpdf
 
@@ -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/)