beautiful docs

.github/workflows/ci.yml

@@ -7,16 +7,19 @@ on:
   pull_request:
 jobs:
   test:
-    name: Julia ${{ matrix.julia-version }} - ${{ github.event_name }}
-    runs-on: ubuntu-latest
+    name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
+    runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        julia-version: '1'
+        include:
+          - version: '1'
+            os: ubuntu-latest
+            arch: x64
     steps:
       - uses: actions/checkout@v4
       - uses: julia-actions/setup-julia@latest
         with:
-          version: ${{ matrix.julia-version }}
+          version: ${{ matrix.version }}
       - uses: julia-actions/cache@v2
       - uses: julia-actions/julia-buildpkg@latest
       - uses: julia-actions/julia-runtest@latest

docs/make.jl

@@ -35,7 +35,7 @@ makedocs(;
         edit_link = "master",
         assets = String[],
     ),
-    pages = ["Home" => "index.md", "API reference" => "api.md"],
+    pages = ["Home" => "index.md", "List of functions" => "api.md"],
 )
 
 deploydocs(; repo = "github.com/araujoms/Ket.jl", devbranch = "master", push_preview = true)

docs/src/api.md

@@ -1,5 +1,65 @@
 # List of functions
 
-```@autodocs
-Modules = [Ket]
+## Basic
+
+```@docs
+ket
+ketbra
+proj
+shift
+clock
+gell_mann
+gell_mann!
+cleanup!
 ```
+
+## States
+
+```@docs
+phiplus
+psiminus
+isotropic
+anti_isotropic
+```
+
+## Measurements
+
+```@docs
+sic_povm
+test_sic
+dilate_povm
+mub
+test_mub
+```
+
+## Nonlocality
+
+```@docs
+chsh
+cglmp
+local_bound
+tsirelson_bound
+correlation_tensor
+probability_tensor
+fp2cg
+```
+
+## Random
+
+```@docs
+random_state
+random_state_vector
+random_unitary
+random_povm
+random_probability
+```
+
+## Entropy
+
+```@docs
+entropy
+binary_entropy
+relative_entropy
+binary_relative_entropy
+```
+