diff --git a/.gitea/workflows/tests.yml b/.gitea/workflows/tests.yml new file mode 100644 index 0000000..2afb5dc --- /dev/null +++ b/.gitea/workflows/tests.yml @@ -0,0 +1,32 @@ +name: Tests + +on: + push: + branches: + - dev + - main + tags-ignore: + - v* + pull_request: + +jobs: + test: + runs-on: ubuntu-latest + container: catthehacker/ubuntu:act-latest + strategy: + matrix: + python-version: ["3.9", "3.10", "3.11"] + + steps: + - uses: actions/checkout@v3 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v3 + with: + python-version: ${{ matrix.python-version }} + env: + AGENT_TOOLSDIRECTORY: /opt/hostedtoolcache + - name: Install dependencies + run: | + python -m pip install -r requirements.txt + - name: Test the build + run: TZ=UTC mkdocs build diff --git a/.renovaterc b/.renovaterc new file mode 100644 index 0000000..c416352 --- /dev/null +++ b/.renovaterc @@ -0,0 +1,20 @@ +{ + "$schema": "https://docs.renovatebot.com/renovate-schema.json", + "extends": [ + "config:base" + ], + "baseBranches": [ + "dev" + ], + "packageRules": [ + { + "matchUpdateTypes": [ + "minor", + "patch", + "pin", + "digest" + ], + "automerge": true + } + ] +} \ No newline at end of file diff --git a/README.md b/README.md index 4a2b981..8cb9b5a 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,3 @@ -# Docs +# Garbage Reminder Documentation +This documentation is under development and is not finished yet. diff --git a/docs/api/configuration.md b/docs/api/configuration.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/api/index.md b/docs/api/index.md new file mode 100644 index 0000000..5932792 --- /dev/null +++ b/docs/api/index.md @@ -0,0 +1 @@ +# API diff --git a/docs/api/installation.md b/docs/api/installation.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/api/upgrading.md b/docs/api/upgrading.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/assets/favicon.png b/docs/assets/favicon.png new file mode 100644 index 0000000..3c30544 Binary files /dev/null and b/docs/assets/favicon.png differ diff --git a/docs/assets/logo.png b/docs/assets/logo.png new file mode 100644 index 0000000..7954279 Binary files /dev/null and b/docs/assets/logo.png differ diff --git a/docs/bot_telegram/configuration.md b/docs/bot_telegram/configuration.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/bot_telegram/index.md b/docs/bot_telegram/index.md new file mode 100644 index 0000000..6d4baf3 --- /dev/null +++ b/docs/bot_telegram/index.md @@ -0,0 +1 @@ +# Telegram Bot diff --git a/docs/bot_telegram/installation.md b/docs/bot_telegram/installation.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/bot_telegram/upgrading.md b/docs/bot_telegram/upgrading.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/community/contact.md b/docs/community/contact.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/community/contributing.md b/docs/community/contributing.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/community/index.md b/docs/community/index.md new file mode 100644 index 0000000..100f4c1 --- /dev/null +++ b/docs/community/index.md @@ -0,0 +1 @@ +# Community diff --git a/docs/community/public/entries.md b/docs/community/public/entries.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/community/public/index.md b/docs/community/public/index.md new file mode 100644 index 0000000..48178cf --- /dev/null +++ b/docs/community/public/index.md @@ -0,0 +1 @@ +# Public instance diff --git a/docs/community/public/locations.md b/docs/community/public/locations.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/community/public/report.md b/docs/community/public/report.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/community/report-bug.md b/docs/community/report-bug.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/community/translate.md b/docs/community/translate.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..a6d7f43 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,3 @@ +# Welcome to Garbage Reminder + +This documentation is under development and is not finished yet. diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css new file mode 100644 index 0000000..1ef4420 --- /dev/null +++ b/docs/stylesheets/extra.css @@ -0,0 +1,5 @@ +:root { + --md-primary-fg-color: #A9C217; + --md-primary-fg-color--light: #A9C217; + --md-primary-fg-color--dark: #A9C217; +} \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..9d6a54b --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,94 @@ +site_name: Garbage Reminder +repo_url: https://git.end-play.xyz/GarbageReminder +repo_name: GarbageReminder +nav: + - Home: index.md + - API: + - api/index.md + - Installation: api/installation.md + - Configuration: api/configuration.md + - Upgrading: api/upgrading.md + - Telegram Bot: + - bot_telegram/index.md + - Installation: bot_telegram/installation.md + - Configuration: bot_telegram/configuration.md + - Upgrading: bot_telegram/upgrading.md + - Community: + - community/index.md + - Contributing: community/contributing.md + - Reporting a bug: community/report-bug.md + - Adding translations: community/translate.md + - Get in touch: community/contact.md + - Public instance: + - community/public/index.md + - Adding entries: community/public/entries.md + - Adding locations: community/public/locations.md + - Report a problem: community/public/report.md +extra: + social: + - icon: fontawesome/brands/git-alt + link: https://git.end-play.xyz/GarbageReminder + - icon: fontawesome/solid/globe + link: https://api.garbagebot.eu/docs + - icon: fontawesome/brands/telegram + link: https://garbagebot.eu/telegram + - icon: fontawesome/brands/discord + link: https://garbagebot.eu/discord +extra_css: + - stylesheets/extra.css +theme: + name: material + logo: assets/logo.png + favicon: assets/favicon.png + features: + - announce.dismiss + - content.action.edit + - content.action.view + - content.code.annotate + - content.code.copy + # - content.code.select + # - content.footnote.tooltips + # - content.tabs.link + - content.tooltips + # - header.autohide + # - navigation.expand + - navigation.footer + - navigation.indexes + # - navigation.instant + # - navigation.instant.prefetch + # - navigation.instant.progress + # - navigation.prune + - navigation.sections + - navigation.tabs + # - navigation.tabs.sticky + - navigation.top + - navigation.tracking + - search.highlight + - search.share + - search.suggest + - toc.follow + # - toc.integrate + palette: + - media: "(prefers-color-scheme)" + toggle: + icon: material/link + name: Switch to light mode + - media: "(prefers-color-scheme: light)" + scheme: default + primary: custom + accent: custom + toggle: + icon: material/toggle-switch + name: Switch to dark mode + - media: "(prefers-color-scheme: dark)" + scheme: slate + primary: custom + accent: custom + toggle: + icon: material/toggle-switch-off + name: Switch to system preference + font: + text: Roboto + code: Roboto Mono + icon: + logo: logo \ No newline at end of file diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..465febe --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +mkdocs-material~=9.5.21 \ No newline at end of file