Added usage for readthedocs in readme
This commit is contained in:
parent
5c5a1c965f
commit
3d5a498d94
17
Readme.md
17
Readme.md
@ -2,4 +2,19 @@
|
||||
This repository contains the code and projects that Ithamar is doing and has done for his Associate Degree.
|
||||
|
||||
## 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.
|
||||
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.
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user