Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Port documentation from Readthedocs to docstrings + Documenter #100

Merged
merged 9 commits into from
Aug 30, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
29 changes: 24 additions & 5 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,31 @@ os:
- osx
julia:
- 0.7
- 1.0
- nightly
notifications:
email: false
# uncomment the following lines to override the default test script
script:
- if [[ -a .git/shallow ]]; then git fetch --unshallow; fi
- julia -e 'Pkg.clone(pwd()); Pkg.build("LossFunctions"); Pkg.test("LossFunctions"; coverage=true)'
git:
depth: 99999999

matrix:
allow_failures:
- julia: nightly

jobs:
include:
- stage: deploy
julia: 1.0
os: linux
script:
- julia -e 'import Pkg; Pkg.clone(pwd()); Pkg.build("LossFunctions")'
- julia -e 'import Pkg; Pkg.add("Documenter")'
- julia -e 'import LossFunctions; ENV["DOCUMENTER_DEBUG"] = "true"; include(joinpath("docs","make.jl"))'

## uncomment the following lines to override the default test script
#script:
# - if [[ -a .git/shallow ]]; then git fetch --unshallow; fi
# - julia --check-bounds=yes --color=yes -e 'import Pkg; Pkg.clone(pwd()); Pkg.build("LossFunctions"); Pkg.test("LossFunctions"; coverage=true)';

after_success:
- julia -e 'cd(Pkg.dir("LossFunctions")); Pkg.add("Coverage"); using Coverage; Coveralls.submit(Coveralls.process_folder())'
- julia -e 'using Pkg; Pkg.add("Coverage"); using Coverage; Coveralls.submit(process_folder())'
2 changes: 1 addition & 1 deletion Project.toml.template
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name = "LossFunctions"
uuid = "7f8f8fb0-2700-5f03-b4bd-41f8cfc144b6"
uuid = "30fc2ffe-d236-52d8-8643-a9d8f7c094a7"
version = "0.2.1"

[deps]
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ that are commonly used in Machine Learning._

| **Package Status** | **Package Evaluator** | **Build Status** |
|:------------------:|:---------------------:|:-----------------:|
| [![License](http://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat)](LICENSE.md) [![Documentation Status](https://img.shields.io/badge/docs-latest-blue.svg?style=flat)](http://lossesjl.readthedocs.io/en/latest/?badge=latest) | [![Pkg Eval 0.6](http://pkg.julialang.org/badges/LossFunctions_0.6.svg)](http://pkg.julialang.org/?pkg=LossFunctions) [![Pkg Eval 0.7](http://pkg.julialang.org/badges/LossFunctions_0.7.svg)](http://pkg.julialang.org/?pkg=LossFunctions) | [![Build Status](https://travis-ci.org/JuliaML/LossFunctions.jl.svg?branch=master)](https://travis-ci.org/JuliaML/LossFunctions.jl) [![Build status](https://ci.appveyor.com/api/projects/status/xbwc2fiel40bajsp?svg=true)](https://ci.appveyor.com/project/Evizero/losses-jl) [![Coverage Status](https://coveralls.io/repos/github/JuliaML/LossFunctions.jl/badge.svg?branch=master)](https://coveralls.io/github/JuliaML/LossFunctions.jl?branch=master) |
| [![License](http://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat)](LICENSE.md) [![Docs](https://img.shields.io/badge/docs-stable-blue.svg)](https://JuliaML.github.io/LossFunctions.jl/stable) | [![Pkg Eval 0.6](http://pkg.julialang.org/badges/LossFunctions_0.6.svg)](http://pkg.julialang.org/?pkg=LossFunctions) [![Pkg Eval 0.7](http://pkg.julialang.org/badges/LossFunctions_0.7.svg)](http://pkg.julialang.org/?pkg=LossFunctions) | [![Build Status](https://travis-ci.org/JuliaML/LossFunctions.jl.svg?branch=master)](https://travis-ci.org/JuliaML/LossFunctions.jl) [![Build status](https://ci.appveyor.com/api/projects/status/xbwc2fiel40bajsp?svg=true)](https://ci.appveyor.com/project/Evizero/losses-jl) [![Coverage Status](https://coveralls.io/repos/github/JuliaML/LossFunctions.jl/badge.svg?branch=master)](https://coveralls.io/github/JuliaML/LossFunctions.jl?branch=master) |

## Available Losses

Expand Down Expand Up @@ -213,7 +213,7 @@ the documentation.

## Documentation

Check out the **[latest documentation](http://lossesjl.readthedocs.io/en/latest/index.html)**
Check out the **[latest documentation](https://JuliaML.github.io/LossFunctions.jl/stable)**

Additionally, you can make use of Julia's native docsystem.
The following example shows how to get additional information
Expand Down Expand Up @@ -256,10 +256,10 @@ This package is registered in `METADATA.jl` and can be installed
as usual

```julia
import Pkg
Pkg.add("LossFunctions")
```

## License

This code is free to use under the terms of the MIT license.

2 changes: 1 addition & 1 deletion REQUIRE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
julia 0.7.0-beta
julia 0.7.0
StatsBase 0.24.0
LearnBase 0.2.0 0.3.0
RecipesBase
4 changes: 2 additions & 2 deletions appveyor.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
environment:
matrix:
- julia_version: 0.7
- julia_version: 1.0
- julia_version: latest

platform:
Expand Down Expand Up @@ -33,4 +33,4 @@ build_script:

test_script:
- echo "%JL_TEST_SCRIPT%"
- julia -e "%JL_TEST_SCRIPT%"
- julia -e "%JL_TEST_SCRIPT%"
2 changes: 2 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
build/
site/
216 changes: 0 additions & 216 deletions docs/Makefile

This file was deleted.

15 changes: 0 additions & 15 deletions docs/about/acknowledgements.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/about/license.rst

This file was deleted.