docs: setup typedoc (#192)

* ci(docs): fix pushing not pushing xml

* docs(build): setup typedoc to generate documentation from ts files

* docs: finish setup autodoc everywhere needed

Author: MartinFillon

.github/workflows/push-docs.yml

@@ -26,22 +26,39 @@ jobs:
           repository: nanoforge-dev/docs
           token: ${{ secrets.ACTIONS_KEY }}
 
+      - name: Install Node.js v24
+        uses: actions/setup-node@v6
+        with:
+          node-version: 24
+          package-manager-cache: false
+          registry-url: https://registry.npmjs.org/
+
+      - uses: pnpm/action-setup@v4.1.0
+        name: Install pnpm
+        with:
+          run_install: false
+          version: 10.22.0 # Couldnt find a way to execute this action in the right directory
+
       - name: setup git
         run: |
           git config --global user.name "github-actions[bot]"
           git config --global user.email "username@users.noreply.github.com"
 
-      - name: setup registry code documentation
-        uses: mattnotmitt/doxygen-action@v1
-        with:
-          doxyfile-path: engine/packages/ecs-lib/docs/Doxyfile
+      - name: install doxygen
+        uses: ssciwr/doxygen-install@v1
+
+      - name: install deps
+        run: cd engine && pnpm i
 
       - name: synchronize docs
         run: |
-          cp -r engine/packages/ecs-lib/docs engine/docs/registry/api
+          cd engine
+          ./scripts/build_docs.sh
+          cd ..
+          rm docs/engine -rf
           mkdir -p docs/engine
           cp -r engine/docs/* docs/engine
           cd docs
-          git add .
-          git commit -m "chore(engine): updating docs"
-          git push origin main
+          git add . || echo "No changes to add"
+          git commit -m "chore(engine): updating docs" || echo "No changes to commit"
+          git push origin main || echo "No changes to push"

.gitignore

@@ -227,3 +227,9 @@ dist
 .turbo/
 
 compile_commands.json
+docs_markdown
+xml
+docs_build
+docs/conf.py
+docs/*/api/index.md
+docs/ecs-lib/api/typescript.md

docs/asset-manager/index.rst

@@ -0,0 +1,7 @@
+asset-manager
+==================
+
+.. toctree::
+
+
+   api/index.md

docs/common/index.rst

@@ -0,0 +1,7 @@
+common
+==================
+
+.. toctree::
+
+
+   api/index.md

docs/config/index.rst

@@ -0,0 +1,7 @@
+config
+==================
+
+.. toctree::
+
+
+   api/index.md

docs/core/index.rst

@@ -0,0 +1,7 @@
+core
+==================
+
+.. toctree::
+
+
+   api/index.md

docs/ecs-client/index.rst

@@ -0,0 +1,7 @@
+ecs-client
+==================
+
+.. toctree::
+
+
+   api/index.md

docs/ecs-lib/index.rst

@@ -0,0 +1,8 @@
+ECS Documentation
+=================
+
+.. toctree::
+
+
+  wasm.rst
+  api/typescript.rst

docs/ecs-lib/wasm.rst

@@ -0,0 +1,11 @@
+C++ classes
+-----------
+
+.. doxygenclass:: nfo::Registry
+    :members:
+
+.. doxygenclass:: nfo::Entity
+    :members:
+
+.. doxygenclass:: nfo::SparseArray
+    :members:

docs/ecs-server/index.rst

@@ -0,0 +1,7 @@
+ecs-server
+==================
+
+.. toctree::
+
+
+   api/index.md