Skip to content

Commit

Permalink
Fix Documenter online docs by moving to new syntax
Browse files Browse the repository at this point in the history
  • Loading branch information
nalimilan committed Nov 1, 2016
1 parent 30aae2a commit 0cae594
Show file tree
Hide file tree
Showing 5 changed files with 65 additions and 50 deletions.
19 changes: 11 additions & 8 deletions docs/src/index.md
Expand Up @@ -2,17 +2,20 @@

## Package Manual

{contents}
Pages = ["man/getting_started.md", "man/io.md", "man/joins.md", "man/split_apply_combine.md", "man/reshaping_and_pivoting.md", "man/sorting.md", "man/formulas.md", "man/pooling.md"]
Depth = 2
```@contents
Pages = ["man/getting_started.md", "man/io.md", "man/joins.md", "man/split_apply_combine.md", "man/reshaping_and_pivoting.md", "man/sorting.md", "man/formulas.md", "man/pooling.md"]
Depth = 2
```

## API

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

## Documentation Index

{index}
Pages = ["lib/maintypes.md", "lib/manipulation.md", "lib/utilities.md", "man/io.md"]
```@index
Pages = ["lib/maintypes.md", "lib/manipulation.md", "lib/utilities.md", "man/io.md"]
```
19 changes: 11 additions & 8 deletions docs/src/lib/maintypes.md
@@ -1,16 +1,19 @@

{meta}
CurrentModule = DataFrames
```@meta
CurrentModule = DataFrames
```

# Main Types

{index}
Pages = ["maintypes.md"]
```@index
Pages = ["maintypes.md"]
```

...

{docs}
AbstractDataFrame
DataFrame
SubDataFrame
```@docs
AbstractDataFrame
DataFrame
SubDataFrame
```

28 changes: 16 additions & 12 deletions docs/src/lib/manipulation.md
@@ -1,22 +1,26 @@

{meta}
CurrentModule = DataFrames
```@meta
CurrentModule = DataFrames
```

# Data Manipulation

{index}
Pages = ["manipulation.md"]
```@index
Pages = ["manipulation.md"]
```

## Joins

{docs}
join
```@docs
join
```

## Reshaping

{docs}
melt
stack
unstack
stackdf
meltdf
```@docs
melt
stack
unstack
stackdf
meltdf
```
39 changes: 21 additions & 18 deletions docs/src/lib/utilities.md
@@ -1,27 +1,30 @@

{meta}
CurrentModule = DataFrames
```@meta
CurrentModule = DataFrames
```

# Utilities

{index}
Pages = ["utilities.md"]
```@index
Pages = ["utilities.md"]
```

...

{docs}
eltypes
head
complete_cases
complete_cases!
describe
dump
names!
nonunique
rename
rename!
tail
unique
unique!
```@docs
eltypes
head
complete_cases
complete_cases!
describe
dump
names!
nonunique
rename
rename!
tail
unique
unique!
```


10 changes: 6 additions & 4 deletions docs/src/man/io.md
Expand Up @@ -4,17 +4,19 @@

To read data from a CSV-like file, use the `readtable` function:

{docs}
readtable
```@docs
readtable
```

`readtable` requires that you specify the path of the file that you would like to read as a `String`. To read data from a non-file source, you may also supply an `IO` object. It supports many additional keyword arguments: these are documented in the section on advanced I/O operations.

## Exporting data to a tabular data file

To write data to a CSV file, use the `writetable` function:

{docs}
writetable
```@docs
writetable
```

## Supplying `DataFrame`s inline with non-standard string literals

Expand Down

0 comments on commit 0cae594

Please sign in to comment.