Docs

Documentation for group student project based on mkdocs.

How to run

Wisit our website

We're hosting our documentation online, here is the link: documetation

Docker

Install Docker: Ensure that Docker is installed and running on your computer. You can download it from the official Docker website.
Run the Documentation Server: Use the following command to start the documentation server with Docker. This command mounts your current directory to the /docs directory in the container and starts the MkDocs server with the Material theme.
```
docker run --rm -it -v ${PWD}:/docs squidfunk/mkdocs-material new .
```

Note: If you are using a Windows command prompt, replace ${PWD} with %cd%. If you're using PowerShell, use ${PWD}.

Python

Install Python: Ensure that Python is installed on your computer. You can download it from the official Python website. It's recommended to use Python 3.6 or higher.
Install Project Dependencies: Navigate to the project directory and install the required dependencies using the following command:
```
python -m pip install -r requirements.txt
```
Run the Documentation Server: Start the local MkDocs server using the command below. This will serve your documentation site locally and enable live reloading for changes.
```
python -m mkdocs serve
```

After running this command, you should see output indicating that the server is running, and you can view your documentation in a web browser at the address provided (typically http://127.0.0.1:8000/).

Creating UML schematics

Gaphor

Download gaphor. When creating schematics save the graphor project to the graphor directory. Export them to docs/assets/uml - svg format.

groupplants / docs