Skip to content

Commit

Permalink
Begin documentation site (#4)
Browse files Browse the repository at this point in the history
  • Loading branch information
ellisvalentiner authored Oct 25, 2017
1 parent 0509adf commit 5e6f9cb
Show file tree
Hide file tree
Showing 6 changed files with 52 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,5 @@
*.jl.*.cov
*.jl.mem
.DS_Store
docs/build/
docs/site/
2 changes: 2 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ notifications:
git:
depth: 99999999
after_success:
- julia -e 'Pkg.add("Documenter")'
- julia -e 'cd(Pkg.dir("AlphaVantage")); include(joinpath("docs", "make.jl"))'
- julia -e 'cd(Pkg.dir("AlphaVantage")); Pkg.add("Coverage"); using Coverage; Coveralls.submit(Coveralls.process_folder())'
- julia -e 'cd(Pkg.dir("AlphaVantage")); Pkg.add("Coverage"); using Coverage; Codecov.submit(Codecov.process_folder())'
env:
Expand Down
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@

[![codecov.io](http://codecov.io/github/ellisvalentiner/AlphaVantage.jl/coverage.svg?branch=master)](http://codecov.io/github/ellisvalentiner/AlphaVantage.jl?branch=master)

[![](https://img.shields.io/badge/docs-stable-blue.svg)](https://ellisvalentiner.github.io/AlphaVantage.jl/stable)
[![](https://img.shields.io/badge/docs-latest-blue.svg)](https://ellisvalentiner.github.io/AlphaVantage.jl/latest)

A Julia wrapper for the Alpha Vantage API.

## Overview
Expand Down
10 changes: 10 additions & 0 deletions docs/make.jl
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
using Documenter, AlphaVantage

makedocs()

deploydocs(
deps = Deps.pip("mkdocs", "python-markdown-math"),
repo = "github.com/ellisvalentiner/AlphaVantage.jl.git",
julia = "0.6",
osname = "osx"
)
24 changes: 24 additions & 0 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
site_name: AlphaVantage.jl
repo_url: https://github.com/ellisvalentiner/AlphaVantage.jl
site_description: A Julia wrapper for the Alpha Vantage API.
site_author: Ellis Valentiner

theme: material

extra_css:
- assets/Documenter.css

extra_javascript:
- https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML
- assets/mathjaxhelper.js

markdown_extensions:
- extra
- tables
- fenced_code
- mdx_math

docs_dir: 'build'

pages:
- Home: index.md
11 changes: 11 additions & 0 deletions docs/src/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# AlphaVantage.jl Documentation

```@docs
intraday()
daily()
daily_adjusted()
weekly()
weekly_adjusted()
monthly()
monthly_adjusted()
```

0 comments on commit 5e6f9cb

Please sign in to comment.