diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 941d1154..3e7b97a5 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -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 diff --git a/.gitignore b/.gitignore index c96e00fb..656c7e39 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,7 @@ Manifest.toml +/docs/build/ + examples/figures/ examples/*.md examples/*.pdf @@ -19,9 +21,6 @@ test/**/chunk_options.jl test/**/*.ipynb !test/**/*ref.* -doc/build -doc/site - .idea *.*~ *.aux diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 2baf28a5..00000000 --- a/.travis.yml +++ /dev/null @@ -1,14 +0,0 @@ -language: julia - -jobs: - include: - - stage: "Documentation" - julia: 1 - os: linux - script: - - julia --project=doc/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()' - - julia --project=doc/ doc/make.jl - after_success: skip - -notifications: - email: false diff --git a/doc/Project.toml b/docs/Project.toml similarity index 100% rename from doc/Project.toml rename to docs/Project.toml diff --git a/doc/assets/FIR_design.pdf b/docs/assets/FIR_design.pdf similarity index 100% rename from doc/assets/FIR_design.pdf rename to docs/assets/FIR_design.pdf diff --git a/doc/assets/FIR_design_plots.pdf b/docs/assets/FIR_design_plots.pdf similarity index 100% rename from doc/assets/FIR_design_plots.pdf rename to docs/assets/FIR_design_plots.pdf diff --git a/doc/make.jl b/docs/make.jl similarity index 85% rename from doc/make.jl rename to docs/make.jl index 98c80f9f..9d4d34aa 100644 --- a/doc/make.jl +++ b/docs/make.jl @@ -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 = [ diff --git a/doc/make_examples.jl b/docs/make_examples.jl similarity index 53% rename from doc/make_examples.jl rename to docs/make_examples.jl index 34011c96..26a0260a 100644 --- a/doc/make_examples.jl +++ b/docs/make_examples.jl @@ -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) diff --git a/doc/src/chunk_options.md b/docs/src/chunk_options.md similarity index 100% rename from doc/src/chunk_options.md rename to docs/src/chunk_options.md diff --git a/doc/src/function_index.md b/docs/src/function_index.md similarity index 100% rename from doc/src/function_index.md rename to docs/src/function_index.md diff --git a/doc/src/getting_started.md b/docs/src/getting_started.md similarity index 100% rename from doc/src/getting_started.md rename to docs/src/getting_started.md diff --git a/doc/src/header.md b/docs/src/header.md similarity index 100% rename from doc/src/header.md rename to docs/src/header.md diff --git a/doc/src/index.md b/docs/src/index.md similarity index 100% rename from doc/src/index.md rename to docs/src/index.md diff --git a/doc/src/notebooks.md b/docs/src/notebooks.md similarity index 100% rename from doc/src/notebooks.md rename to docs/src/notebooks.md diff --git a/doc/src/publish.md b/docs/src/publish.md similarity index 100% rename from doc/src/publish.md rename to docs/src/publish.md diff --git a/doc/src/usage.md b/docs/src/usage.md similarity index 100% rename from doc/src/usage.md rename to docs/src/usage.md