GarbageReminder/Docs

Documentation for the API and the bots. https://garbagebot.eu

mkdocs python python3 website

Go to file

profitroll 7c5dd326bd All checks were successful Tests / test (3.10) (push) Successful in 9s Details Tests / test (3.11) (push) Successful in 8s Details Tests / test (3.9) (push) Successful in 8s Details Tests / test (3.10) (pull_request) Successful in 9s Details Tests / test (3.11) (pull_request) Successful in 9s Details Tests / test (3.9) (pull_request) Successful in 9s Details Added index and API docs. Fixed accent color		2024-05-13 23:41:45 +02:00
.gitea/workflows	Initial sections commit	2024-05-12 14:58:27 +02:00
docs	Added index and API docs. Fixed accent color	2024-05-13 23:41:45 +02:00
.gitignore	Initial commit	2024-05-12 02:53:14 +03:00
.renovaterc	Initial sections commit	2024-05-12 14:58:27 +02:00
LICENSE	Initial commit	2024-05-12 02:53:14 +03:00
mkdocs.yml	More sections added	2024-05-13 23:41:07 +02:00
README.md	Repo readme improved	2024-05-13 23:41:17 +02:00
requirements.txt	Initial sections commit	2024-05-12 14:58:27 +02:00

README.md

Garbage Reminder Documentation

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

Clone the repo using git clone https://git.end-play.xyz/GarbageReminder/Docs.git
Go to the Docs directory
Create a virtual environment using python -m venv .venv
Activate it using .venv/bin/activate or .venv\Scripts\activate.bat
Install the dependencies using pip install -r requirements.txt
Build the docs using mkdocs build
Deploy as any other file-based website. The generated website is under site