GarbageReminder/Docs
GarbageReminder/Docs
1
0
Fork 0
Code Issues Pull Requests Actions Releases Wiki Activity
Documentation for the API and the bots. https://garbagebot.eu
14 Commits 2 Branches 0 Tags 214 KiB
Text 100%
main
Go to file
Profitroll 1c82c800e9
All checks were successful
Tests / test (3.10) (push) Successful in 9s
Details
Tests / test (3.11) (push) Successful in 9s
Details
Tests / test (3.9) (push) Successful in 9s
Details
Merge pull request 'attr_list, start and deployment pages, more about public instance' (#4) from dev into main 
Reviewed-on: #4
2024-05-26 15:29:28 +03:00
.gitea/workflows Initial sections commit 2024-05-12 14:58:27 +02:00
docs Added more info about public instance 2024-05-26 14:27:12 +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 Enabled attr_list 2024-05-26 14:26:50 +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

  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