Merge pull request #9 from NewTec-GmbH/feature/build_docu

Add build instruction
NewTec-GmbH · Oct 28, 2024 · cc2674e · cc2674e
2 parents 1c06197 + 035c9d7
commit cc2674e
Show file tree

Hide file tree

Showing 2 changed files with 39 additions and 6 deletions.
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -4,7 +4,7 @@
     "version": "2.0.0",
     "tasks": [
         {
-            "label": "Python Requirements",
+            "label": "Install Python Requirements",
             "type": "shell",
             "command": [
                 "pip",
@@ -13,19 +13,19 @@
                 "requirements.txt"
             ],
             "group": {
-                "kind": "requirements"
+                "kind": "none"
             },
             "problemMatcher": []
         },
         {
-            "label": "NPM Requirements",
+            "label": "Install NPM Requirements",
             "type": "shell",
             "command": [
                 "npm",
                 "install"
             ],
             "group": {
-                "kind": "requirements"
+                "kind": "none"
             },
             "problemMatcher": []
         },
@@ -38,7 +38,7 @@
                 "NPM Requirements"
             ],
             "group": {
-                "kind": "requirements"
+                "kind": "none"
             },
             "problemMatcher": []
         },
@@ -71,7 +71,7 @@
                 "_build"
             ],
             "problemMatcher": []
-        }
+        },
         {
             "label": "Build and open",
             "type": "shell",

diff --git a/README.md b/README.md
@@ -4,6 +4,39 @@
 
 This is the documentation for the NewTec Git Work Instructions. You can find the resulting GitHub Pages in [here](https://newtec-gmbh.github.io/gitWorkInstructions/).
 
+## Build the documentation
+
+### Requirements
+
+* Node 20
+* Python 3.11
+
+### Instructions
+
+1. Clone the repository: `git clone https://github.com/NewTec-GmbH/gitWorkInstructions.git`
+2. Change directory: `cd gitWorkInstructions`
+3. Install Python dependencies: `pip install -r requirements.txt`
+4. Install Node dependencies: `npm install`
+5. Build the documentation: `sphinx-build doc _build --fail-on-warning`
+6. Open the documentation: `_build/index.html`
+
+### Visual Studio Code Tasks
+
+If you are using VSCode, the commands mentioned above are packed into tasks, making it easier for the developer to use.
+
+1. Clone the repository: `git clone https://github.com/NewTec-GmbH/gitWorkInstructions.git`
+2. Open the folder with VSCode: `code ./gitWorkInstructions`
+3. On the top menu, choose `Terminal` -> `Run Task...` and select the task you require.
+
+#### Available Tasks
+
+* Install Python Requirements
+* Install NPM Requirements
+* Install all requirements
+* Build
+* Clean
+* Build and open
+
 ## Used Libraries
 
 Used 3rd party libraries which are not part of the standard Python package: