Merge pull request #5515 from camptocamp/theme-doc

Generate theme documentation

.github/workflows/ci.yaml

@@ -50,6 +50,7 @@ jobs:
       - run: "! (npm run typecheck|grep -v '^node_modules/'|grep '^[a-z]')"
       # Generate API doc
       - run: npm run doc
+      - run: npm run jsdoc
       - run: npm run build-api
       - run: cat /home/runner/.npm/_logs/*
         if: failure()

README.md

@@ -18,7 +18,6 @@ standalone builds of ngeo can be created.
 To know more about ngeo take a look at:
 
 * The [examples](https://camptocamp.github.io/ngeo/master/examples)
-* The [simple API help](https://camptocamp.github.io/ngeo/master/api/apihelp/apihelp.html)
 * The documentation can be found in each file. There is currently no API web-documentation for this
   version (you may also use [API documentation](https://camptocamp.github.io/ngeo/master/apidoc/index.html)).
 

buildtools/doc-readme.md

@@ -0,0 +1,7 @@
+API documentation of ngeo.
+
+[Theme api](../jsdoc/global.html)
+
+[GitHub project page](https://github.com/camptocamp/ngeo/)
+
+[The examples](../examples)

buildtools/publish

@@ -28,6 +28,7 @@ git rm --ignore-unmatch -r --quiet --force ${GIT_BRANCH} || true
 mkdir -p ${GIT_BRANCH}/examples
 cp -r .build/examples-hosted/* ${GIT_BRANCH}/examples/
 cp -r apidoc ${GIT_BRANCH}/
+cp -r jsdoc/build ${GIT_BRANCH}/jsdoc
 cp -r api/dist ${GIT_BRANCH}/api
 
 # Rewrite root commit and force push

jsdoc/config.json

@@ -0,0 +1,8 @@
+{
+    "plugins": [
+        "jsdoc-plugin-typescript"
+    ],
+    "typescript": {
+      "moduleRoot": "contribs/gmf/src"
+    }
+  }

package.json

@@ -15,7 +15,8 @@
     "serve-api": "webpack-dev-server --content-base=api/dist/apihelp/ --config=buildtools/webpack.api.js --https --cert=private.crt --key=private.key --port=3000 --mode=development --progress --watch --debug",
     "build-gmf-apps-profile": "TARGET=gmf-apps webpack --profile --json > profile.json",
     "typecheck": "tsc",
-    "doc": "typedoc --name ngeo --mode file --excludePrivate --excludeProtected --ignoreCompilerErrors --excludeExternals --exclude '**/examples/**,**/test/**' --out apidoc"
+    "doc": "typedoc --name ngeo --mode file --excludePrivate --excludeProtected --ignoreCompilerErrors --excludeExternals --exclude '**/examples/**,**/test/**' --readme buildtools/doc-readme.md --out apidoc",
+    "jsdoc": "jsdoc contribs/gmf/src/themes.js --configure jsdoc/config.json --destination jsdoc/build"
   },
   "sideEffects": false,
   "repository": {
@@ -100,6 +101,8 @@
     "jquery-mousewheel": "3.1.13",
     "jquery-ui": "1.12.1",
     "jquery-ui-touch-punch": "0.2.3",
+    "jsdoc": "3.6.3",
+    "jsdoc-plugin-typescript": "2.0.5",
     "jsts": "2.1.0",
     "karma": "4.4.1",
     "karma-chrome-launcher": "3.1.0",