From 36493d29bebfc260e0b28ce0b1931dd9f8582c4d Mon Sep 17 00:00:00 2001 From: Josh Day Date: Sat, 2 Mar 2024 06:26:37 -0500 Subject: [PATCH] start Documenter docs --- .github/workflows/Docs.yml | 28 ++++++++++++++++++++++++++++ docs/.gitignore | 2 ++ docs/Project.toml | 2 ++ docs/make.jl | 13 +++++++++++++ docs/src/index.md | 7 +++++++ 5 files changed, 52 insertions(+) create mode 100644 .github/workflows/Docs.yml create mode 100644 docs/.gitignore create mode 100644 docs/Project.toml create mode 100644 docs/make.jl create mode 100644 docs/src/index.md diff --git a/.github/workflows/Docs.yml b/.github/workflows/Docs.yml new file mode 100644 index 0000000..b119d63 --- /dev/null +++ b/.github/workflows/Docs.yml @@ -0,0 +1,28 @@ +name: Documentation + +on: + push: + branches: + - master # update to match your development branch (master, main, dev, trunk, ...) + tags: '*' + pull_request: + +jobs: + build: + permissions: + contents: write + statuses: write + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: julia-actions/setup-julia@v1 + with: + version: '1.6' + - uses: julia-actions/cache@v1 + - 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 }} # If authenticating with GitHub Actions token + DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # If authenticating with SSH deploy key + run: julia --project=docs/ docs/make.jl diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..a303fff --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,2 @@ +build/ +site/ diff --git a/docs/Project.toml b/docs/Project.toml new file mode 100644 index 0000000..dfa65cd --- /dev/null +++ b/docs/Project.toml @@ -0,0 +1,2 @@ +[deps] +Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" diff --git a/docs/make.jl b/docs/make.jl new file mode 100644 index 0000000..efbcb8d --- /dev/null +++ b/docs/make.jl @@ -0,0 +1,13 @@ +using Documenter +using PlotlyLight + +makedocs( + sitename = "PlotlyLight", + format = Documenter.HTML(), + modules = [PlotlyLight] +) + + +deploydocs( + repo = "https://github.com/juliacomputing/plotlylight.jl" +) diff --git a/docs/src/index.md b/docs/src/index.md new file mode 100644 index 0000000..dc6cb6e --- /dev/null +++ b/docs/src/index.md @@ -0,0 +1,7 @@ +# PlotlyLight.jl + +Documentation for PlotlyLight.jl + +@example ``` +Plot(y=rand(10)) +```