move REPL docs to stdlib

JuliaLang · Jan 14, 2018 · cceda76 · cceda76
1 parent fb5d2f0
commit cceda76
Show file tree

Hide file tree

Showing 8 changed files with 23 additions and 19 deletions.
diff --git a/doc/make.jl b/doc/make.jl
@@ -1,9 +1,9 @@
 # Install dependencies needed to build the documentation.
 ENV["JULIA_PKGDIR"] = joinpath(@__DIR__, "deps")
-Pkg.init()
-cp(joinpath(@__DIR__, "REQUIRE"), Pkg.dir("REQUIRE"); remove_destination = true)
-Pkg.update()
-Pkg.resolve()
+#Pkg.init()
+#cp(joinpath(@__DIR__, "REQUIRE"), Pkg.dir("REQUIRE"); remove_destination = true)
+#Pkg.update()
+#Pkg.resolve()
 
 using Documenter
 
@@ -73,7 +73,6 @@ const PAGES = [
         "manual/networking-and-streams.md",
         "manual/parallel-computing.md",
         "manual/dates.md",
-        "manual/interacting-with-julia.md",
         "manual/running-external-programs.md",
         "manual/calling-c-and-fortran-code.md",
         "manual/handling-operating-system-variation.md",

diff --git a/doc/src/base/base.md b/doc/src/base/base.md
@@ -21,7 +21,6 @@ Some general notes:
 Base.exit
 Base.quit
 Base.atexit
-Base.atreplinit
 Base.isinteractive
 Base.varinfo
 Base.summarysize

diff --git a/doc/src/index.md b/doc/src/index.md
@@ -39,7 +39,6 @@ Please read the [release notes](NEWS.md) to see what has changed since the last
   * [Calling C and Fortran Code](@ref)
   * [Handling Operating System Variation](@ref)
   * [Environment Variables](@ref)
-  * [Interacting With Julia](@ref)
   * [Embedding Julia](@ref)
   * [Packages](@ref)
   * [Profiling](@ref)
@@ -79,6 +78,7 @@ Please read the [release notes](NEWS.md) to see what has changed since the last
 
 ## Standard Library
 
+  * [The Julia REPL](@ref)
   * [Base64](@ref)
   * [CRC32c](@ref)
   * [Dates and Time](@ref stdlib-dates)

diff --git a/doc/src/manual/environment-variables.md b/doc/src/manual/environment-variables.md
@@ -207,7 +207,7 @@ Environment variables that determine how REPL output should be formatted at the
 terminal. Generally, these variables should be set to [ANSI terminal escape
 sequences](http://ascii-table.com/ansi-escape-sequences.php). Julia provides
 a high-level interface with much of the same functionality: see the section on
-[Interacting With Julia](@ref).
+[The Julia REPL](@ref).
 
 ### `JULIA_ERROR_COLOR`
 

diff --git a/doc/src/manual/index.md b/doc/src/manual/index.md
@@ -28,7 +28,6 @@
   * [Calling C and Fortran Code](@ref)
   * [Handling Operating System Variation](@ref)
   * [Environment Variables](@ref)
-  * [Interacting With Julia](@ref)
   * [Embedding Julia](@ref)
   * [Packages](@ref)
   * [Package Development](@ref)

diff --git a/doc/src/manual/unicode-input.md b/doc/src/manual/unicode-input.md
@@ -19,7 +19,7 @@ the symbol).
 #
 # Generate a table containing all LaTeX and Emoji tab completions available in the REPL.
 #
-
+import REPL
 const NBSP = '\u00A0'
 
 function tab_completions(symbols...)
@@ -75,8 +75,8 @@ end
 
 table_entries(
     tab_completions(
-        Base.REPLCompletions.latex_symbols,
-        Base.REPLCompletions.emoji_symbols
+        REPL.REPLCompletions.latex_symbols,
+        REPL.REPLCompletions.emoji_symbols
     ),
     unicode_data()
 )

diff --git a/doc/src/manual/workflow-tips.md b/doc/src/manual/workflow-tips.md
@@ -4,7 +4,7 @@ Here are some tips for working with Julia efficiently.
 
 ## REPL-based workflow
 
-As already elaborated in [Interacting With Julia](@ref), Julia's REPL provides rich functionality
+As already elaborated in [The Julia REPL](@ref), Julia's REPL provides rich functionality
 that facilitates an efficient interactive workflow. Here are some tips that might further enhance
 your experience at the command line.
 

diff --git a/doc/src/manual/interacting-with-julia.md → stdlib/REPL/docs/src/index.md b/doc/src/manual/interacting-with-julia.md → stdlib/REPL/docs/src/index.md
@@ -1,4 +1,4 @@
-# Interacting With Julia
+# The Julia REPL
 
 Julia comes with a full-featured interactive command-line REPL (read-eval-print loop) built into
 the `julia` executable. In addition to allowing quick and easy evaluation of Julia statements,
@@ -196,16 +196,17 @@ to do so).
 ### Customizing keybindings
 
 Julia's REPL keybindings may be fully customized to a user's preferences by passing a dictionary
-to `REPL.setup_interface()`. The keys of this dictionary may be characters or strings. The key
+to `REPL.setup_interface`. The keys of this dictionary may be characters or strings. The key
 `'*'` refers to the default action. Control plus character `x` bindings are indicated with `"^x"`.
 Meta plus `x` can be written `"\\Mx"`. The values of the custom keymap must be `nothing` (indicating
 that the input should be ignored) or functions that accept the signature `(PromptState, AbstractREPL, Char)`.
-The `REPL.setup_interface()` function must be called before the REPL is initialized, by registering
-the operation with `atreplinit()`. For example, to bind the up and down arrow keys to move through
+The `REPL.setup_interface` function must be called before the REPL is initialized, by registering
+the operation with [`atreplinit`](@ref) . For example, to bind the up and down arrow keys to move through
 history without prefix search, one could put the following code in `.juliarc.jl`:
 
 ```julia
-import Base: LineEdit, REPL
+import REPL
+import REPL.LineEdit
 
 const mykeys = Dict{Any,Any}(
     # Up Arrow
@@ -255,7 +256,7 @@ julia> e¹ = [1 0]
 1×2 Array{Int64,2}:
  1  0
 
-julia> \sqrt[TAB]2     # √ is equivalent to the sqrt() function
+julia> \sqrt[TAB]2     # √ is equivalent to the sqrt function
 julia> √2
 1.4142135623730951
 
@@ -375,3 +376,9 @@ ENV["JULIA_ERROR_COLOR"] = :magenta
 ENV["JULIA_WARN_COLOR"] = :yellow
 ENV["JULIA_INFO_COLOR"] = :cyan
 ```
+
+## References
+
+```@docs
+REPL.atreplinit
+```