Documentation

.github/workflows/integration.yaml

@@ -39,7 +39,7 @@ jobs:
           source_paths: "documentation/document.typ"
           root_path: '.' 
 
-       - name: Compile Typst to PDF
+      - name: Compile Typst to PDF
         uses: mkpoli/compile-typst-action@main
         with:
           source_paths: "examples/*.typ"

README.md

@@ -2,6 +2,8 @@
 
 Template to create exams with header, school letterhead, grade chart, ...
 
+[![.github/workflows/integration.yaml](https://github.com/MatheSchool/typst-g-exam/actions/workflows/integration.yaml/badge.svg)](https://github.com/MatheSchool/typst-g-exam/actions/workflows/integration.yaml)
+
 ## Features 
 
 - Scoreboard.

documentation/document.typ

@@ -1,8 +1,15 @@
 #import "@preview/tidy:0.2.0"
 // https://github.com/Mc-Zen/tidy
 
-#let docs = tidy.parse-module(
-  read("../g-exam.typ"),
-  name: "g-exam (Exam generator)")
+#let exam-docs = tidy.parse-module(
+  read("../src/g-exam.typ"),
+  name: "Exam definition")
 
-#tidy.show-module(docs, style: tidy.styles.default) 
+#let command-docs = tidy.parse-module(
+  read("../src/g-command.typ"),
+  name: "Command definitions")
+
+
+#tidy.show-module(exam-docs, style: tidy.styles.default) 
+
+#tidy.show-module(command-docs, style: tidy.styles.default) 

src/g-command.typ

@@ -1,6 +1,16 @@
 // #import "./g-exam.typ": *
 #import"./global.typ": *
 
+/// Show a question.
+/// 
+/// *Example:*
+/// ``` 
+/// #g-question(point:2)[This is a question]
+/// ```
+///
+/// - point (none, float): Points of the question.
+/// - point-position(none, left, right): Position of points. If none,  use the position defined in G-Exam. 
+/// - body (string, content): Body of question.
 #let g-question(
     point: none, 
     point-position: none, 
@@ -57,6 +67,16 @@
   })
 }
 
+/// Show a sub-question.
+/// 
+/// *Example:*
+/// ``` 
+/// #g-subquestion(point:2)[This is a sub-question]
+/// ```
+///
+/// - point (none, float): Points of the sub-question.
+/// - point-position(none, left, right): Position of points. If none,  use the position defined in G-Exam. 
+/// - body (string, content): Body of sub-question.
 #let g-subquestion(
     point: none, 
     point-position: none,