Skip to content
New issue

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

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

Already on GitHub? # to your account

Adds docs #35

Merged
merged 8 commits into from
Nov 16, 2018
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
*.jl.cov
*.jl.*.cov
*.jl.mem
/docs/build/
morris25 marked this conversation as resolved.
Show resolved Hide resolved
6 changes: 4 additions & 2 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ os:
julia:
- 0.6
- 0.7
- 1.0
- nightly

# # Uncomment the following lines to allow failures on nightly julia
Expand All @@ -23,5 +24,6 @@ notifications:
# - julia -e 'Pkg.clone(pwd()); Pkg.build("Example"); Pkg.test("Example"; coverage=true)';

after_success:
- julia -e 'cd(Pkg.dir("Example")); Pkg.add("Coverage"); using Coverage; Coveralls.submit(Coveralls.process_folder())';
# - julia -e 'cd(Pkg.dir("Example")); Pkg.add("Coverage"); using Coverage; Codecov.submit(Codecov.process_folder())';
- julia -e 'if VERSION >= v"0.7.0-" using Pkg end; cd(Pkg.dir("Example")); Pkg.add("Coverage"); using Coverage; Coveralls.submit(Coveralls.process_folder())';
# - julia -e 'if VERSION >= v"0.7.0-" using Pkg end; cd(Pkg.dir("Example")); Pkg.add("Coverage"); using Coverage; Codecov.submit(Codecov.process_folder())';
- julia -e 'if VERSION >= v"0.7.0-" using Pkg end; Pkg.add("Documenter"); cd(Pkg.dir("Example")); include(joinpath("docs", "make.jl"))'
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, Example

makedocs(modules = [Example])

if get(ENV, "TEST_DOCS", "false") != "true"
morris25 marked this conversation as resolved.
Show resolved Hide resolved
deploydocs(
repo = "github.com/JuliaLang/Example.jl.git",
julia = "1.0"
)
end
7 changes: 7 additions & 0 deletions docs/src/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Example

Example Julia package repo.

```@autodocs
Modules = [Example]
```
11 changes: 11 additions & 0 deletions src/Example.jl
Original file line number Diff line number Diff line change
@@ -1,7 +1,18 @@
module Example
export hello, domath

"""
hello(who::String)

Return "Hello, `who`".
"""
hello(who::String) = "Hello, $who"

"""
domath(x::Number)

Return `x + 5`.
"""
domath(x::Number) = x + 5

end