IthamarHerrewijnen/Ithamar_code
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added usage for readthedocs in readme

Browse Source
This commit is contained in:
Eljakim Herrewijnen 2022-11-19 20:30:58 +01:00
parent 5c5a1c965f
commit 3d5a498d94
1 changed files with 16 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
Readme.md
View File

@ -3,3 +3,18 @@ This repository contains the code and projects that Ithamar is doing and has don
## Structure
the documentation/ folder contains the **readthedocs** source that will be updated by Ithamar according to the assignments he needs to make. The **assignments** folder contains the assignments made by Ithamar.
### Usage:
To build the navigation, go to *documentation/readthedocs* and execute:
```
make html
```
Next, navigate to build/html and run a webserver:
```
python3 -m http.server
```
This will start a webserver on port **localhost:8000**. Navigate to this URL in your browser.