Merge branch 'main' of https://github.com/thowell/CALIPSO.jl into main

.github/workflows/Documenter.yml

@@ -0,0 +1,24 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - main
+    tags: '*'
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: julia-actions/setup-julia@latest
+        with:
+          version: 1.7
+      - 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

README.md

@@ -1,5 +1,6 @@
 [![CI](https://github.com/thowell/CALIPSO.jl/actions/workflows/CI.yml/badge.svg)](https://github.com/thowell/CALIPSO.jl/actions/workflows/CI.yml)
 [![codecov](https://codecov.io/gh/thowell/CALIPSO.jl/branch/main/graph/badge.svg?token=RNX4943S70)](https://codecov.io/gh/thowell/CALIPSO.jl)
+[![](https://img.shields.io/badge/docs-dev-blue.svg)](https://thowell.github.io/CALIPSO.jl/dev)
 
 # CALIPSO.jl
 Conic Augmented Lagrangian Interior-Point SOlver: A solver for contact-implicit trajectory optimization
@@ -21,7 +22,7 @@ $$
 can be optimized for 
 
 - $x$: decision variables 
-- $\theta$: problem parameters 
+- $\theta$: problem data
 - $\mathcal{K}$: Cartesian product of convex cones; nonnegative orthant $\mathbf{R}_+$ and second-order cones $\mathcal{Q}$ are currently implemented
 
 ## Trajectory optimization
@@ -45,7 +46,7 @@ $$
 \partial w^*(\theta) / \partial \theta,
 $$
 
-with respect to the problem parameters are efficiently computed.
+with respect to the problem data are efficiently computed.
 
 ## Examples
 

docs/make.jl

@@ -1,6 +1,6 @@
 push!(LOAD_PATH, "../src/")
 
-using Documenter#, CALIPSO
+using Documenter, CALIPSO
 
 makedocs(
     modules = [CALIPSO],