docs: setup auto push of generated documentation for ecs

Author: MartinFillon

.github/workflows/push-docs.yml

@@ -4,6 +4,12 @@ on:
   push:
     branches:
       - main
+    paths:
+      - "*.rst"
+      - "Doxyfile"
+      - "ecs-lib/"
+      - "ecs-server/"
+      - "ecs-client/"
   workflow_dispatch:
 
 jobs:
@@ -27,6 +33,14 @@ jobs:
           git config --global user.name "github-actions[bot]"
           git config --global user.email "username@users.noreply.github.com"
 
+      - name: setup registry code documentation
+        run: |
+          apt install doxygen -y
+          cd engine/packages/ecs-lib/docs
+          doxygen Doxyfile
+          cd -
+          cp engine/packages/ecs-lib/docs engine/docs/registry/api
+
       - name: synchronize docs
         run: |
           mkdir -p docs/engine

README.md

@@ -1,3 +1,5 @@
+[![Nanoforge Documentation](https://github.com/NanoForge-dev/docs/actions/workflows/deploy.yml/badge.svg)](https://github.com/NanoForge-dev/docs/actions/workflows/deploy.yml)
+
 # Engine
 
 This repository contains the full engine for NanoForge.
@@ -20,6 +22,10 @@ This is the full nanoforge engine including all the default libraries.
 
 In order to manage this project we use (pnpm)[https://pnpm.io/]
 
+## Documentation
+
+The full documentation can be found at: [https://nanoforge-dev.github.io/docs/engine](https://nanoforge-dev.github.io/docs/engine)
+
 ## Installing dependencies
 
 To install dependencies run:

docs/.gitignore

@@ -0,0 +1 @@
+Doxyfile

packages/ecs-lib/.gitignore

@@ -274,4 +274,4 @@ lib/index.js
 lib/libecs.js
 compile_commands.json
 emsdk/
-doc_out/
+docs/xml

packages/ecs-lib/docs/Doxyfile

@@ -4,4 +4,4 @@ GENERATE_LATEX = NO
 
 INPUT = ../wasm
 
-OUTPUT_DIRECTORY = doc_out
+OUTPUT_DIRECTORY = .