Skip to content

Commit

Permalink
Add build instruction #7
Browse files Browse the repository at this point in the history
  • Loading branch information
gabryelreyes committed Oct 26, 2024
1 parent d591763 commit 78a7d31
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,22 @@

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`

## Used Libraries

Used 3rd party libraries which are not part of the standard Python package:
Expand Down

0 comments on commit 78a7d31

Please sign in to comment.