Add documentation and docstrings, change type names

.github/workflows/CI.yml

@@ -1,9 +1,5 @@
 name: CI
 on:
-  pull_request:
-    branches:
-      - main
-      - devel
   push:
     branches: '*'
     tags: '*'
@@ -13,8 +9,9 @@ jobs:
     runs-on: ${{ matrix.os }}
     env:
       JULIA_NUM_THREADS: 8
+      JULIA_EXTENDED_TESTS: false
     strategy:
-      fail-fast: false
+      fail-fast: true
       matrix:
         version:
           - '1.7.2'

.github/workflows/CI_extended.yml

@@ -0,0 +1,50 @@
+name: CI
+on:
+  pull_request:
+    branches:
+      - main
+  push:
+    branches:
+      - main
+jobs:
+  test:
+    name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
+    runs-on: ${{ matrix.os }}
+    env:
+      JULIA_NUM_THREADS: 8
+      JULIA_EXTENDED_TESTS: true
+    strategy:
+      fail-fast: false
+      matrix:
+        version:
+          - '^1.8.0-0'
+          - '1.7.3'
+        os:
+          - ubuntu-latest
+          - macos-latest
+          - windows-latest
+        arch:
+          - x64
+    steps:
+      - uses: actions/checkout@v2
+      - uses: julia-actions/setup-julia@v1
+        with:
+          version: ${{ matrix.version }}
+          arch: ${{ matrix.arch }}
+      - uses: actions/cache@v1
+        env:
+          cache-name: cache-artifacts
+        with:
+          path: ~/.julia/artifacts
+          key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-test-${{ env.cache-name }}-
+            ${{ runner.os }}-test-
+            ${{ runner.os }}-
+      - uses: julia-actions/julia-buildpkg@v1
+      - uses: julia-actions/julia-runtest@v1
+      - uses: julia-actions/julia-processcoverage@v1
+      - uses: codecov/codecov-action@v2
+        with:
+          file: lcov.info
+          require_ci_to_pass: false

.github/workflows/documentation.yml

@@ -24,4 +24,4 @@ jobs:
         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
+        run: julia --color=yes --project=docs/ docs/make.jl

docs/make.jl

@@ -6,26 +6,59 @@ makedocs(
         "index.md",
         "Tutorials" => [
             "A first model" => "tutorials/first_model.md",
-            "Model specification" => [
+            "Our Concept of a Structural Equation Model" => "tutorials/concept.md",
+            "Model Specification" => [
                 "tutorials/specification/specification.md",
                 "tutorials/specification/graph_interface.md",
-                "tutorials/specification/ram_matrices.md"],
-            "Model construction" => ["tutorials/construction/build_by_parts.md"],
-            "Model fitting" => [],
-            "Model inspection" => [],
-            "Multigroup SEM" => [
-                "tutorials/multigroup/multigroup.md",
-                "tutorials/multigroup/collection.md"
-            ]
+                "tutorials/specification/ram_matrices.md",
+                "tutorials/specification/parameter_table.md"],
+            "Model Construction" => [
+                "tutorials/construction/construction.md",
+                "tutorials/construction/outer_constructor.md",
+                "tutorials/construction/build_by_parts.md"],
+            "Optimization Backends" => [
+                "tutorials/backends/optim.md",
+                "tutorials/backends/nlopt.md"
+            ],
+            "Model Fitting" => "tutorials/fitting/fitting.md",
+            "Model Inspection" => "tutorials/inspection/inspection.md",
+            "Mean Structures" => "tutorials/meanstructure.md",
+            "Collections" => [
+                "tutorials/collection/collection.md",
+                "tutorials/collection/multigroup.md"
+            ],
+            "Constraints" => "tutorials/constraints/constraints.md"
         ],
         "Developer documentation" => [
+            "Extending the package" => "developer/extending.md",
             "Custom loss functions" => "developer/loss.md",
             "Custom imply types" => "developer/imply.md",
-            "Custom sem types" => "developer/sem.md"
+            "Custom diff types" => "developer/diff.md",
+            "Custom observed types" => "developer/observed.md",
+            "Custom model types" => "developer/sem.md"
         ],
+        "Performance tips" => [
+            "Model sorting" => "performance/sorting.md",
+            "MKL" => "performance/mkl.md",
+            "Simulation studies" => "performance/simulation.md",
+            "Symbolic precomputation" => "performance/symbolic.md",
+            "Starting values" => "performance/starting_values.md",
+            "Parametric Types" => "performance/parametric.md"
+        ],
+        "Internals and design" => [
+            "Internals and design" => "internals/internals.md",
+            "files" => "internals/files.md",
+            "types" => "internals/types.md"
+        ],
+        "Complementary material" => [
+            "Mathematical appendix" => "complementary/maths.md"
+        ]
     ],
     format = Documenter.HTML(
-        prettyurls = get(ENV, "CI", nothing) == "true"
+        prettyurls = get(ENV, "CI", nothing) == "true",
+        assets = ["assets/favicon_zeta.ico"],
+        ansicolor = true,
+        collapselevel = 1
     ),
     doctest = false
 )