Skip to content

typedoc

Because angular code is written in typescript and not in javascript, jsdoc will not work.

Sphinx has an extension with which javascript can be read with jsdoc, but unfortunately not typescript. That's why the frontend code documentation will be generated with a different tool called typedoc.

installation

install
1
2
3
4
sudo npm install -g 
cd frontend
mkdir docs
npm install --save-dev typedoc

Add this to the package.json file :

package.json
1
2
3
4
5
6
"scripts": { 
    ..
              "docs": "npm run typedoc -- --options typedoc.json --exclude '**/*.spec.ts' ./app/",
    "typedoc": "typedoc",
    ..
          }

Also make a file called typedoc.json with the following settings:

typedoc.json
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
    "mode": "modules",
    "out": "docs",
    "theme": "default",
    "ignoreCompilerErrors": "true",
    "experimentalDecorators": "true",
    "emitDecoratorMetadata": "true",
    "target": "ES5",
    "moduleResolution": "node",
    "preserveConstEnums": "true",
    "stripInternal": "true",
    "suppressExcessPropertyErrors": "true",
    "suppressImplicitAnyIndexErrors": "true",
    "module": "commonjs"
}

The documentation can then be generated with :

generate
1
typedoc --out docs --module amd src/