Skip to content

Commit baa6376

Browse files
author
a
committed
add docs infra
1 parent bbfd353 commit baa6376

File tree

3 files changed

+43
-0
lines changed

3 files changed

+43
-0
lines changed

doc/Project.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[deps]
2+
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
3+
TermInterface = "8ea1fca8-c5ef-4a55-8b96-4e9afe9c9a3c"

doc/liveserver.jl

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
#!/usr/bin/env julia
2+
3+
# Root of the repository
4+
const repo_root = dirname(@__DIR__)
5+
6+
# Make sure docs environment is active
7+
import Pkg
8+
Pkg.activate(@__DIR__)
9+
using TermInterface
10+
11+
# Communicate with docs/make.jl that we are running in live mode
12+
push!(ARGS, "liveserver")
13+
14+
# Run LiveServer.servedocs(...)
15+
import LiveServer
16+
LiveServer.servedocs(;
17+
# Documentation root where make.jl and src/ are located
18+
foldername=joinpath(repo_root, "docs"),
19+
skip_dirs=[
20+
# exclude assets folder because it is modified by docs/make.jl
21+
joinpath(repo_root, "docs", "src", "assets"),
22+
],
23+
)

doc/make.jl

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
using Documenter
2+
using TermInterface
3+
4+
const TERMINTERFACE_PATH = dirname(pathof(Metatheory))
5+
6+
7+
makedocs(
8+
modules=[TermInterface],
9+
sitename="TermInterface.jl",
10+
pages=[
11+
"index.md"
12+
"api.md"
13+
"Tutorials" => tutorials
14+
],
15+
)
16+
17+
deploydocs(repo="github.com/JuliaSymbolics/TermInterface.jl.git")

0 commit comments

Comments
 (0)