Skip to content

Commit 71feb24

Browse files
committed
Add API reference to generated docs
1 parent 29289b2 commit 71feb24

File tree

3 files changed

+18
-15
lines changed

3 files changed

+18
-15
lines changed

.travis.yml

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,8 @@ before_script:
2121
- sleep 5
2222
after_success:
2323
- julia -e 'cd(Pkg.dir("RobotOS")); Pkg.add("Coverage"); using Coverage; Coveralls.submit(Coveralls.process_folder())'
24-
- echo $TRAVIS_JULIA_VERSION
25-
- if [[ -a .git/shallow ]]; then git fetch --unshallow; fi
26-
- julia -e 'run(`lualatex -v`)'
27-
- julia -e 'Pkg.clone(pwd())'
28-
- julia -e 'Pkg.add("RobotOS.jl")'
2924
- julia -e 'Pkg.add("Documenter");'
30-
- julia -e 'cd(Pkg.dir("RobotOSDocs"));ENV["DOCUMENTER_DEBUG"]=true; include(joinpath("docs", "make.jl"))'
25+
- julia -e 'cd(Pkg.dir("RobotOS")); ENV["DOCUMENTER_DEBUG"]="true"; include(joinpath("docs", "make.jl"))'
3126
after_script:
3227
- killall roscore
3328
- killall python

docs/make.jl

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
11
using Documenter,RobotOS
2-
makedocs(modules=[RobotOS],
3-
doctest=false, clean=true,
4-
format =:html,
5-
authors="Josh Langsfeld",
6-
sitename="RobotOS.jl",
7-
pages = Any[
2+
3+
makedocs(
4+
modules=[RobotOS],
5+
doctest=false, clean=true,
6+
format =:html,
7+
authors="Josh Langsfeld",
8+
sitename="RobotOS.jl",
9+
pages = Any[
810
"Home" => "index.md"
9-
]
10-
)
11+
"API Reference" => "api.md"
12+
]
13+
)
1114

1215
deploydocs(
1316
deps=Deps.pip("mkdocs","python-markdown-math"),
@@ -17,4 +20,4 @@ deploydocs(
1720
target="build",
1821
osname="linux",
1922
julia="0.6",
20-
make=nothing)
23+
)

docs/src/api.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# API Reference
2+
3+
```@autodocs
4+
Modules = [RobotOS]
5+
```

0 commit comments

Comments
 (0)