attempt to deploy docs (#10)

* resize logo to layout

* makedocs OK again

* add deploydocs

.github/workflows/documentation.yml

@@ -0,0 +1,37 @@
+name: docs
+on:
+  push:
+    branches:
+      - main
+    tags: '*'
+  pull_request:
+concurrency:
+  # Skip intermediate builds: always.
+  # Cancel intermediate builds: only if it is a pull request build.
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
+jobs:
+  docs:
+    name: Documentation
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      statuses: write
+    steps:
+      - uses: actions/checkout@v2
+      - uses: julia-actions/setup-julia@v1
+        with:
+          version: '1'
+      - uses: julia-actions/julia-buildpkg@v1
+      - uses: julia-actions/julia-docdeploy@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
+      - run: |
+          julia --project=docs -e '
+            using Documenter: DocMeta, doctest
+            using RheumaComposites
+            using Unitful
+            using DocumenterInterLinks
+            DocMeta.setdocmeta!(RheumaComposites, :DocTestSetup, :(using RheumaComposites, Unitful); recursive=true)
+            doctest(RheumaComposites)'

.gitignore

@@ -1,5 +1,4 @@
 /**/Manifest.toml
 /**/build
-/docs/src/*.md
 .vscode/
 /**/.DS_Store

docs/Project.toml

@@ -3,3 +3,6 @@ Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 DocumenterInterLinks = "d12716ef-a0f6-4df4-a9f1-a5a34e75c656"
 RheumaComposites = "579811c7-86f9-4c5f-9fea-fbfdecde0101"
 Unitful = "1986cc42-f94f-5a68-af5c-568840ba703d"
+
+[compat]
+Documenter = "1.5"

docs/make.jl

@@ -15,3 +15,5 @@ makedocs(;
     modules=[RheumaComposites],
     plugins=[links],
 )
+
+deploydocs(; repo="github.com/simonsteiger/RheumaComposites.jl", devbranch="main")

docs/src/index.md

@@ -0,0 +1,57 @@
+# API reference
+
+```@docs
+RheumaComposites
+```
+
+## Types
+
+```@docs
+AbstractComposite
+ContinuousComposite
+BooleanComposite
+ModifiedComposite
+DAS28
+DAS28ESR
+DAS28CRP
+SDAI
+CDAI
+Faceted
+BooleanRemission
+Revised
+ThreeItem
+AbstractComponent
+PGA
+SJC28
+```
+
+## Interface
+
+```@docs
+t28
+s28
+pga
+apr
+ega
+crp
+```
+
+## Functions
+
+```@docs
+intercept
+weight
+score
+isremission
+decompose
+categorise
+faceted
+revised
+threeitem
+value
+```
+
+## Index
+
+```@index
+```