Skip to content

Commit

Permalink
Update documentation, remove duplicate files, move to doctests
Browse files Browse the repository at this point in the history
  • Loading branch information
cjprybol committed Oct 11, 2017
1 parent 8fd0851 commit a7136b9
Show file tree
Hide file tree
Showing 18 changed files with 1,315 additions and 318 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ DataFrames.jl
=============

[![0.6](http://pkg.julialang.org/badges/DataFrames_0.6.svg)](http://pkg.julialang.org/?pkg=DataFrames)
[![0.7](http://pkg.julialang.org/badges/DataFrames_0.7.svg)](http://pkg.julialang.org/?pkg=DataFrames)
<!-- [![0.7](http://pkg.julialang.org/badges/DataFrames_0.7.svg)](http://pkg.julialang.org/?pkg=DataFrames) -->

[![Coverage Status](https://coveralls.io/repos/JuliaData/DataFrames.jl/badge.svg?branch=master&service=github)](https://coveralls.io/github/JuliaData/DataFrames.jl?branch=master)
[![Travis Build Status](https://travis-ci.org/JuliaData/DataFrames.jl.svg?branch=master)](https://travis-ci.org/JuliaData/DataFrames.jl)
Expand Down
11 changes: 3 additions & 8 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,11 @@ makedocs(
"Reshaping" => "man/reshaping_and_pivoting.md",
"Sorting" => "man/sorting.md",
"Categorical Data" => "man/categorical.md",
"Querying frameworks" => "man/querying_frameworks.md",
"Querying frameworks" => "man/querying_frameworks.md"
],
"API" => Any[
"Main types" => "lib/maintypes.md",
"Utilities" => "lib/utilities.md",
"Data manipulation" => "lib/manipulation.md",
],
"About" => Any[
"Release Notes" => "NEWS.md",
"License" => "LICENSE.md",
"Types" => "lib/types.md",
"Functions" => "lib/functions.md"
]
]
)
Expand Down
23 changes: 0 additions & 23 deletions docs/src/LICENSE.md

This file was deleted.

Empty file removed docs/src/NEWS.md
Empty file.
29 changes: 24 additions & 5 deletions docs/src/index.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,40 @@
# DataFrames Documentation Outline
# DataFrames.jl

Welcome to the DataFrames documentation! This resource aims to teach you everything you need
to know to get up and running with tabular data manipulation using the DataFrames.jl package
and the Julia language. If there is something you expect DataFrames to be capable of, but
cannot figure out how to do, please reach out with questions in Domains/Data on
[Discourse](https://discourse.julialang.org/new-topic?title=[DataFrames%20Question]:%20&body=%23%20Question:%0A%0A%23%20Dataset%20(if%20applicable):%0A%0A%23%20MWE%20(if%20applicable):%0A&category=Domains/Data&tags=question).
You can also give feedback and suggest features or improvements by
[opening an issue](https://github.com/JuliaData/DataFrames.jl/issues/new). You can follow
the [**source**]() links throughout the documentation to jump right to the
source files on GitHub to make pull requests for improving the documentation and function
capabilities. Please review
[DataFrames contributing guidelines](https://github.com/JuliaData/DataFrames.jl/blob/master/CONTRIBUTING.md)
before submitting your first PR!

## Package Manual

```@contents
Pages = ["man/getting_started.md", "man/joins.md", "man/split_apply_combine.md", "man/reshaping_and_pivoting.md", "man/sorting.md", "man/categorical.md", "man/querying_frameworks.md"]
Pages = ["man/getting_started.md",
"man/joins.md",
"man/split_apply_combine.md",
"man/reshaping_and_pivoting.md",
"man/sorting.md",
"man/categorical.md",
"man/querying_frameworks.md"]
Depth = 2
```

## API

```@contents
Pages = ["lib/maintypes.md", "lib/manipulation.md", "lib/utilities.md"]
Pages = ["lib/types.md", "lib/functions.md"]
Depth = 2
```

## Documentation Index
## Index

```@index
Pages = ["lib/maintypes.md", "lib/manipulation.md", "lib/utilities.md"]
Pages = ["lib/types.md", "lib/functions.md"]
```
86 changes: 86 additions & 0 deletions docs/src/lib/functions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
```@meta
CurrentModule = DataFrames
```

# Functions

```@index
Pages = ["functions.md"]
```

## Joins

```@docs
join
```

## Reshaping

```@docs
melt
stack
unstack
stackdf
meltdf
```

## Data Manipulation

```@docs
aggregate
by
colwise
groupby
```

## DataFrame Manipulation

```@docs
categorical!
combine
deleterows!
dropnull
dropnull!
names!
nullable!
rename!
rename
unique!
```

## Iteration

```@docs
eachcol
eachrow
```

## Descriptive

```@docs
completecases
describe
eltypes
names
nonunique
ncol
nrow
showcols
size
```

## IO

```@docs
head
printtable
tail
show
```

## Sorting and Ordering

```@docs
sort
order
```
25 changes: 0 additions & 25 deletions docs/src/lib/manipulation.md

This file was deleted.

7 changes: 5 additions & 2 deletions docs/src/lib/maintypes.md → docs/src/lib/types.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,17 @@
CurrentModule = DataFrames
```

# Main Types
# Types

```@index
Pages = ["maintypes.md"]
Pages = ["types.md"]
```

```@docs
AbstractDataFrame
DataFrame
DataFrameRow
GroupApplied
GroupedDataFrame
SubDataFrame
```
26 changes: 0 additions & 26 deletions docs/src/lib/utilities.md

This file was deleted.

Loading

0 comments on commit a7136b9

Please sign in to comment.