Move docs from readme to docs and add a doc build

+ extract docstrings from the public API and get them onto an API reference page.
JuliaLang · May 29, 2023 · a6a6181 · a6a6181
1 parent 68d3fbd
commit a6a6181
Show file tree

Hide file tree

Showing 12 changed files with 1,425 additions and 1,341 deletions.
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -95,18 +95,18 @@ jobs:
             ${{ runner.os }}-
       - uses: julia-actions/julia-buildpkg@v1
       - run: julia sysimage/compile.jl
-#  docs:
-#    name: Documentation
-#    runs-on: ubuntu-latest
-#    steps:
-#      - uses: actions/checkout@v2
-#      - uses: julia-actions/setup-julia@latest
-#        with:
-#          version: '1.6'
-#      - run: julia --project=docs -e '
-#          using Pkg;
-#          Pkg.develop(PackageSpec(; path=pwd()));
-#          Pkg.instantiate();'
-#      - run: julia --project=docs docs/make.jl
-#        env:
-#          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+  docs:
+    name: Documentation
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: julia-actions/setup-julia@latest
+        with:
+          version: '1.9'
+      - run: julia --project=docs -e '
+          using Pkg;
+          Pkg.develop(PackageSpec(; path=pwd()));
+          Pkg.instantiate();'
+      - run: julia --project=docs docs/make.jl
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}