added some missing documentation

OptimalDesignLab · Jul 9, 2024 · 5bfd97c · 5bfd97c
1 parent b83624e
commit 5bfd97c
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 7 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -16,9 +16,9 @@ jobs:
         with:
           version: '1'
       - uses: julia-actions/julia-buildpkg@v1
-      # uncomment the clock below to build documentation
-      # - name: Build and deploy
-      #   env:
-      #     GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 
-      #     DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} 
-        # run: julia --project=. docs/make.jl
+      # uncomment the block below to build documentation
+      - name: Build and deploy
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} 
+        run: julia --project=. docs/make.jl
diff --git a/docs/make.jl b/docs/make.jl
@@ -2,6 +2,7 @@
 # ] pkg> activate .
 # ] pkg> instantiate
 # run include("make.jl")
+# or from the root, run in the shell: julia --project=docs docs/make.jl
 
 using Pkg 
 push!(LOAD_PATH,"../../src/")

diff --git a/docs/src/reference.md b/docs/src/reference.md
@@ -255,7 +255,7 @@ Constructors for the SBP operator classes.
 # outerconstructor.jl
 # This file gathers together outer constructors for the SBP operators
 ```
-```docs
+```@docs
 SummationByParts.getLineSegSBPLobbato
 SummationByParts.getLineSegSBPLegendre
 SummationByParts.getTriSBPGamma