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

build docs via actions #378

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all 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
14 changes: 14 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -65,3 +65,17 @@ jobs:
name: codecov-umbrella
fail_ci_if_error: false
token: ${{ secrets.CODECOV_TOKEN }}
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: julia-actions/setup-julia@latest
with:
version: 1.4
- name: Install dependencies
run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
- name: Build and deploy
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # For authentication with GitHub Actions token
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # For authentication with SSH deploy key
run: julia --project=docs/ docs/make.jl
5 changes: 2 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
Manifest.toml

/docs/build/

examples/figures/
examples/*.md
examples/*.pdf
Expand All @@ -19,9 +21,6 @@ test/**/chunk_options.jl
test/**/*.ipynb
!test/**/*ref.*

doc/build
doc/site

.idea
*.*~
*.aux
Expand Down
14 changes: 0 additions & 14 deletions .travis.yml

This file was deleted.

File renamed without changes.
File renamed without changes.
File renamed without changes.
3 changes: 1 addition & 2 deletions doc/make.jl → docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@ CI_FLG = get(ENV, "CI", nothing) == "true"
makedocs(
modules = [Weave],
format = Documenter.HTML(
prettyurls = CI_FLG,
canonical = "http://weavejl.mpastell.com/stable/",
prettyurls = CI_FLG
),
sitename = "Weave.jl",
pages = [
Expand Down
17 changes: 5 additions & 12 deletions doc/make_examples.jl → docs/make_examples.jl
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,11 @@ let start_dir = pwd()
weave("../examples/FIR_design_plots.jl", doctype = "md2html", out_path = "build/examples")

# PDF outputs
if haskey(ENV, "TRAVIS")
# in Travis, just cp already generated PDFs
cp("assets/FIR_design.pdf", "build/examples/FIR_design.pdf", force = true)
cp("assets/FIR_design_plots.pdf", "build/examples/FIR_design_plots.pdf", force = true)
else
# otherwise try to generate them
try
weave("../examples/FIR_design.jmd", doctype = "md2pdf", out_path = "assets")
weave("../examples/FIR_design_plots.jl", doctype = "md2pdf", out_path = "assets")
catch err
@error err
end
try
weave("../examples/FIR_design.jmd", doctype = "md2pdf", out_path = "assets")
weave("../examples/FIR_design_plots.jl", doctype = "md2pdf", out_path = "assets")
catch err
@error err
end

cp("../examples/FIR_design.jmd", "build/examples/FIR_design.jmd", force = true)
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.