Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
foldfelis committed Aug 7, 2021
1 parent 527d71e commit ef44cac
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 11 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ Download file or Google Sheet from Google drive via the share link:

```julia
using Fetch
gdownload("https://drive.google.com/file/d/1OiX6gEWRm57kb1H8L0K_HWN_pzc-sk8y/view?usp=sharing", pwd())
link = "https://drive.google.com/file/d/1OiX6gEWRm57kb1H8L0K_HWN_pzc-sk8y/view?usp=sharing"
gdownload(link, pwd())
```

## Download dataset from Kaggle
Expand All @@ -29,12 +30,14 @@ Download dataset from Kaggle via the name:

```julia
using Fetch
kdownload("ningjingyu/fetchtest", pwd())
dataset = "ningjingyu/fetchtest"
kdownload(dataset, pwd())
```

## Intergrate with DataDeps.jl

According to [DataDeps.jl](https://github.com/oxinabox/DataDeps.jl), `DataDep` can be construct as following:
According to [DataDeps.jl](https://github.com/oxinabox/DataDeps.jl),
`DataDep` can be construct as following:

```julia
DataDep(
Expand Down Expand Up @@ -84,5 +87,7 @@ register(DataDep(
datadep"FetchTest"
```

According to the document of [Kaggle-api](https://github.com/Kaggle/kaggle-api#api-credentials) one needs to set their environment variables `KAGGLE_USERNAME` and `KAGGLE_KEY`,
or simply download the api token from Kaggle, and place this file in the location `~/.kaggle/kaggle.json` (on Windows in the location `C:\Users\<Windows-username>\.kaggle\kaggle.json`).
According to the document of [Kaggle-api](https://github.com/Kaggle/kaggle-api#api-credentials)
one needs to set their environment variables `KAGGLE_USERNAME` and `KAGGLE_KEY`,
or simply download the api token from Kaggle, and place this file in the location `~/.kaggle/kaggle.json`
(on Windows in the location `C:\Users\<Windows-username>\.kaggle\kaggle.json`).
18 changes: 12 additions & 6 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ Download file or Google Sheet from Google drive via the share link:

```julia
using Fetch
gdownload("https://drive.google.com/file/d/1OiX6gEWRm57kb1H8L0K_HWN_pzc-sk8y/view?usp=sharing", pwd())
link = "https://drive.google.com/file/d/1OiX6gEWRm57kb1H8L0K_HWN_pzc-sk8y/view?usp=sharing"
gdownload(link, pwd())
```

## Download dataset from Kaggle
Expand All @@ -30,12 +31,14 @@ Download dataset from Kaggle via the name:

```julia
using Fetch
kdownload("ningjingyu/fetchtest", pwd())
dataset = "ningjingyu/fetchtest"
kdownload(dataset, pwd())
```

## Intergrate with DataDeps.jl

According to [DataDeps.jl](https://github.com/oxinabox/DataDeps.jl), `DataDep` can be construct as following:
According to [DataDeps.jl](https://github.com/oxinabox/DataDeps.jl),
`DataDep` can be construct as following:

```julia
DataDep(
Expand Down Expand Up @@ -85,13 +88,16 @@ register(DataDep(
datadep"FetchTest"
```

According to the document of [Kaggle-api](https://github.com/Kaggle/kaggle-api#api-credentials)
one needs to set their environment variables `KAGGLE_USERNAME` and `KAGGLE_KEY`,
or simply download the api token from Kaggle, and place this file in the location `~/.kaggle/kaggle.json`
(on Windows in the location `C:\Users\<Windows-username>\.kaggle\kaggle.json`).

## Index

```@index
```

```@autodocs
Modules = [Fetch]
```

According to the document of [Kaggle-api](https://github.com/Kaggle/kaggle-api#api-credentials) one needs to set their environment variables `KAGGLE_USERNAME` and `KAGGLE_KEY`,
or simply download the api token from Kaggle, and place this file in the location `~/.kaggle/kaggle.json` (on Windows in the location `C:\Users\<Windows-username>\.kaggle\kaggle.json`).

0 comments on commit ef44cac

Please sign in to comment.