Skip to content

Commit

Permalink
Port manual to Documenter (#275)
Browse files Browse the repository at this point in the history
Move all content to docstrings when they were missing or incomplete.
Fix many details in docstrings. Improve in particular docstrings
for sampling algorithms, analysis of signals, and stats models.
  • Loading branch information
nalimilan committed Jun 27, 2017
1 parent 43f9f2c commit 9c92c1e
Show file tree
Hide file tree
Showing 47 changed files with 914 additions and 1,704 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
docs/build
docs/site
perf/*.csv
1 change: 1 addition & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,4 @@ git:
# - julia -e 'Pkg.clone(pwd()); Pkg.build("StatsBase"); Pkg.test("StatsBase"; coverage=true)'
after_success:
- julia -e 'cd(Pkg.dir("StatsBase")); Pkg.add("Coverage"); using Coverage; Coveralls.submit(Coveralls.process_folder())'
- julia -e 'Pkg.add("Documenter"); cd(Pkg.dir("StatsBase")); include(joinpath("docs", "make.jl"))'
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,10 @@
[![Build Status](https://travis-ci.org/JuliaStats/StatsBase.jl.svg?branch=master)](https://travis-ci.org/JuliaStats/StatsBase.jl)
[![Coverage Status](https://coveralls.io/repos/JuliaStats/StatsBase.jl/badge.svg?branch=master)](https://coveralls.io/r/JuliaStats/StatsBase.jl?branch=master)

- **Documentation:** [![Documentation Status](https://readthedocs.org/projects/statsbasejl/badge/?version=latest)](https://readthedocs.org/projects/statsbasejl/?badge=latest) <http://statsbasejl.readthedocs.org/en/latest/>
- **Documentation**: [![][docs-stable-img]][docs-stable-url] [![][docs-latest-img]][docs-latest-url]

[docs-latest-img]: https://img.shields.io/badge/docs-latest-blue.svg
[docs-latest-url]: http://JuliaStats.github.io/StatsBase.jl/latest/

[docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg
[docs-stable-url]: http://JuliaStats.github.io/StatsBase.jl/stable/
153 changes: 0 additions & 153 deletions docs/Makefile

This file was deleted.

27 changes: 27 additions & 0 deletions docs/make.jl
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
using Documenter, StatsBase

makedocs(
format = :html,
sitename = "StatsBase.jl",
# options
modules = [StatsBase],
pages = ["index.md",
"weights.md",
"means.md",
"scalarstats.md",
"robust.md",
"deviation.md",
"cov.md",
"counts.md",
"ranking.md",
"sampling.md",
"empirical.md",
"signalcorr.md",
"misc.md",
"statmodels.md"]
)

deploydocs(
repo = "github.com/JuliaStats/StatsBase.jl.git",
julia = "0.6"
)
Loading

0 comments on commit 9c92c1e

Please sign in to comment.