2024-05-12 15:58:27 +03:00
|
|
|
# Garbage Reminder Documentation
|
2024-05-12 02:53:14 +03:00
|
|
|
|
2024-05-14 00:41:17 +03:00
|
|
|
Documentation made with MkDocs Material for API, bots and contributions.
|
|
|
|
|
|
|
|
|
|
## Requirements
|
|
|
|
|
|
|
|
|
|
* Git
|
|
|
|
|
* Python 3.8+ (tested on 3.9 to 3.11)
|
|
|
|
|
|
|
|
|
|
## Building the docs
|
|
|
|
|
|
|
|
|
|
1. Clone the repo using `git clone https://git.end-play.xyz/GarbageReminder/Docs.git`
|
|
|
|
|
2. Go to the `Docs` directory
|
|
|
|
|
3. Create a virtual environment using `python -m venv .venv`
|
|
|
|
|
4. Activate it using `.venv/bin/activate` or `.venv\Scripts\activate.bat`
|
|
|
|
|
5. Install the dependencies using `pip install -r requirements.txt`
|
|
|
|
|
6. Build the docs using `mkdocs build`
|
|
|
|
|
7. Deploy as any other file-based website. The generated website is under `site`
|
