Merge pull request #50 from Potits-chats/LMST2-67-Cr-er-Docs-document…

…ation

Add documentation generator angular

README.md

@@ -14,6 +14,10 @@ Run `ng generate component component-name` to generate a new component. You can
 
 Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory.
 
+## Documentation
+
+Run `npm run doc` to generate the documentation. The documentation will be stored in the `documentation/` directory.
+
 ## Running unit tests
 
 Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).

package.json

@@ -7,7 +7,8 @@
     "build": "ng build",
     "build:prod": "ng build --configuration production",
     "watch": "ng build --watch --configuration development",
-    "test": "ng test"
+    "test": "ng test",
+    "doc": "npx compodoc -p tsconfig.doc.json"
   },
   "private": true,
   "dependencies": {

tsconfig.doc.json

@@ -0,0 +1,4 @@
+{
+    "include": ["src/**/*.ts"],
+    "exclude": ["src/test.ts", "src/**/*.spec.ts", "src/app/file-to-exclude.ts"]
+}