Add documentation with Documenter

.github/workflows/CI.yml

@@ -5,6 +5,9 @@ on:
       - main
     tags: '*'
   pull_request:
+    branches:
+      - main
+      - develop
 concurrency:
   # Skip intermediate builds: always.
   # Cancel intermediate builds: only if it is a pull request build.
@@ -18,11 +21,19 @@ jobs:
       fail-fast: false
       matrix:
         version:
+          - '1.6' # Replace this with the minimum Julia version that your package supports.
           - '1'
         os:
           - ubuntu-latest
         arch:
           - x64
+        include:
+          - os: windows-latest
+            version: '1'
+            arch: x64
+          - os: macOS-latest
+            version: '1'
+            arch: x64
     steps:
       - uses: actions/checkout@v2
       - uses: julia-actions/setup-julia@v1
@@ -43,16 +54,21 @@ jobs:
       - uses: actions/checkout@v2
       - uses: julia-actions/setup-julia@v1
         with:
-          version: '1'
-      - uses: julia-actions/julia-buildpkg@v1
-      - uses: julia-actions/julia-docdeploy@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
-        # Run doctests
+          version: '1.6'
       - run: |
+          julia --project=docs -e '
+            using Pkg
+            Pkg.develop(PackageSpec(path=pwd()))
+            Pkg.instantiate()'
+      - name: Run doctests
+        run: |
           julia --project=docs -e '
             using Documenter: DocMeta, doctest
             using DataWorkstation
             DocMeta.setdocmeta!(DataWorkstation, :DocTestSetup, :(using DataWorkstation); recursive=true)
             doctest(DataWorkstation)'
+      - name: Build and deploy
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
+        run: julia --project=docs/ docs/make.jl

Project.toml

@@ -14,6 +14,10 @@ Serialization = "9e88b42a-f829-5b0c-bbe9-9e923198166b"
 TOML = "fa267f1f-6049-4f14-aa54-33bafae1ed76"
 
 [compat]
+DataFrames = "1"
+CSV = "0.10"
+BSON = "0.3"
+JDF = "0.5"
 julia = "1.6.5"
 
 [extras]

docs/README.md

@@ -13,7 +13,7 @@ Building the documentation
 
 The documentation is built using the following command:
 
-```julia
+```bash
 julia --project=. --color=yes make.jl
 ```
 

docs/make.jl

@@ -11,18 +11,21 @@ DocMeta.setdocmeta!(
 makedocs(;
     modules = [DataWorkstation],
     authors = "Leandro Ferrado <leferrad@gmail.com> and contributors",
-    repo = "https://github.com/leferrad/DataWorkstation.jl/blob/{commit}{path}#{line}",
     sitename = "DataWorkstation.jl",
     format = Documenter.HTML(;
-        prettyurls = get(ENV, "CI", "false") == "true",
+        prettyurls = get(ENV, "CI", nothing) == "true",
         canonical = "https://leferrad.github.io/DataWorkstation.jl",
         assets = String[],
     ),
-    pages = ["Home" => "index.md"],
+    pages = [
+        "Introduction" => ["index.md",],
+        # "User Guide" => ["basics.md", "quick_example.md"],
+        # "API" => ["api_reference.md"],
+    ],
 )
 
 deploydocs(;
-    repo = "github.com/leferrad/DataWorkstation.jl",
-    devbranch = "develop",
+    repo = "github.com/leferrad/DataWorkstation.jl.git",
+    target = "build",
     push_preview = true,
 )