[doc] starting documentation

2025-10-07 16:06:22 +02:00
parent 423754ece3
commit f34cbc6cd2
6 changed files with 131 additions and 0 deletions
--- a/doc/_quarto.yml
+++ b/doc/_quarto.yml
@@ -0,0 +1,63 @@
+# In doc/_quarto.yml
+project:
+  type: website
+  output-dir: _site
+  preview:
+    port: 7000
+
+format:
+  html:
+    # code-fold: true
+    # code-summary: "Show the code"
+    theme: 
+      light: flatly
+      dark: darkly
+    css:
+      - api/_styles-quartodoc.css
+      - styles.css
+    fontsize: 1.1em
+    linestretch: 1.7
+    grid:
+      sidebar-width: 300px
+      body-width: 900px
+      margin-width: 300px
+      gutter-width: 1.5rem
+
+website:
+  title: oepyhs2nix
+  sidebar:
+    title: oepyhs2nix
+    style: "docked"
+    search: true
+    type: "dark"
+    tools:
+      - icon: github
+        href: https://whale.am28.uni-tuebingen.de/git/awendt/oephys2nix
+    contents:
+      - text: "Introduction"
+        href: "index.qmd"
+      - section: "Tutorials"
+        contents:
+        - "usage.qmd"
+      - section: "API"
+        href: "api/index.qmd"
+        contents:
+        - "api/index.qmd"
+
+
+quartodoc:
+  package: oephys2nix
+  dir: "api"
+  css: api/_styles-quartodoc.css
+  renderer:
+    style: markdown
+    table_style: description-list
+  sections:
+    - title: cli
+      desc: Terminal client
+      contents:
+        - main
+
+execute:
+  freeze: auto
+