This is an automated email from the ASF dual-hosted git repository. ericphanson pushed a commit to branch eph/fix-docs in repository https://gitbox.apache.org/repos/asf/arrow-julia.git
commit a8db8cdb7fd41477aae76619a014aa14fd8619e4 Author: Eric Hanson <[email protected]> AuthorDate: Mon Oct 16 11:34:53 2023 +0200 Fix docs --- docs/Project.toml | 3 +++ docs/make.jl | 2 +- docs/src/manual.md | 2 +- docs/src/reference.md | 8 ++++++++ 4 files changed, 13 insertions(+), 2 deletions(-) diff --git a/docs/Project.toml b/docs/Project.toml index 246ba9d..ebc6a27 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -18,3 +18,6 @@ [deps] Arrow = "69666777-d1a9-59fb-9406-91d4454c9d45" Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" + +[compat] +Documenter = "1" diff --git a/docs/make.jl b/docs/make.jl index 4d3511f..b2c86f4 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -20,7 +20,7 @@ using Arrow makedocs(; modules=[Arrow], - repo="https://github.com/apache/arrow-julia/blob/{commit}{path}#L{line}";, + repo=Remotes.GitHub("apache", "arrow-julia"), sitename="Arrow.jl", format=Documenter.HTML(; prettyurls=get(ENV, "CI", "false") == "true", diff --git a/docs/src/manual.md b/docs/src/manual.md index ea36879..802d095 100644 --- a/docs/src/manual.md +++ b/docs/src/manual.md @@ -48,7 +48,7 @@ table = Arrow.Table("data.arrow") ### `Arrow.Table` -The type of `table` in this example will be an `Arrow.Table`. When "reading" the arrow data, `Arrow.Table` first ["mmapped"](https://en.wikipedia.org/wiki/Mmap) the `data.arrow` file, which is an important technique for dealing with data larger than available RAM on a system. By "mmapping" a file, the OS doesn't actually load the entire file contents into RAM at the same time, but file contents are "swapped" into RAM as different regions of a file are requested. Once "mmapped", `Arrow.Ta [...] +The type of `table` in this example will be an `Arrow.Table`. When "reading" the arrow data, `Arrow.Table` first ["mmapped"](https://en.wikipedia.org/wiki/Mmap) the `data.arrow` file, which is an important technique for dealing with data larger than available RAM on a system. By "mmapping" a file, the OS doesn't actually load the entire file contents into RAM at the same time, but file contents are "swapped" into RAM as different regions of a file are requested. Once "mmapped", `Arrow.Ta [...] * [`Arrow.Primitive`](@ref): the most common array type for simple, fixed-size elements like integers, floats, time types, and decimals * [`Arrow.List`](@ref): an array type where its own elements are also arrays of some kind, like string columns, where each element can be thought of as an array of characters diff --git a/docs/src/reference.md b/docs/src/reference.md index 9e395e4..cb62746 100644 --- a/docs/src/reference.md +++ b/docs/src/reference.md @@ -23,3 +23,11 @@ Modules = [Arrow] Order = [:type, :function] ``` + +## Internals: `Arrow.FlatBuffers` + +The `FlatBuffers` module is not part of Arrow.jl's public API, and these functions may change without notice. + +```@autodocs +Modules = [Arrow.FlatBuffers] +```
