created basic documentation

.github/workflows/publish-docs.yml

@@ -4,7 +4,6 @@ on:
   push:
     branches:
       - main
-      - docs/init
 
 permissions:
   contents: write

.github/workflows/publish-to-pypi.yml

@@ -1,6 +1,9 @@
 name: Publish Python 🐍 distributions 📦 to PyPI and TestPyPI
 
-on: push
+on:
+  push:
+    branches:
+      - main
 
 jobs:
   build-n-publish:

docs/docs/getting-started.md

@@ -0,0 +1,3 @@
+# Getting Started
+
+...

docs/docs/index.md

@@ -1,17 +1,11 @@
-# Welcome to MkDocs
+---
+tags:
+  - example
+hide:
+  - tags
+  - navigation
+---
 
-For full documentation visit [mkdocs.org](https://www.mkdocs.org).
+# Home
 
-## Commands
-
-* `mkdocs new [dir-name]` - Create a new project.
-* `mkdocs serve` - Start the live-reloading docs server.
-* `mkdocs build` - Build the documentation site.
-* `mkdocs -h` - Print help message and exit.
-
-## Project layout
-
-    mkdocs.yml    # The configuration file.
-    docs/
-        index.md  # The documentation homepage.
-        ...       # Other markdown pages, images and other files.
+This page is under construction.

docs/docs/tags.md

@@ -0,0 +1,5 @@
+# Tags
+
+Following is a list of relevant tags:
+
+[TAGS]

docs/mkdocs.yml

@@ -1,3 +1,56 @@
-site_name: My Docs
+site_name: EnfoBench
+site_description: EnfoBench is a benchmarking toolkit for energy forecasting models.
+repo_url: https://github.com/attila-balint-kul/energy-forecast-benchmark-toolkit
+repo_name: enfobench
+edit_uri: ''
+copyright: Copyright © 2022 - 2023 Attila Balint
 theme:
-  name: material
+  language: en
+  name: material
+  custom_dir: overrides
+  palette:
+    # Palette toggle for light mode
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+
+    # Palette toggle for dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      toggle:
+        icon: material/brightness-4
+        name: Switch to system preference
+  icon:
+    logo: bootstrap/highlighter
+    repo: fontawesome/brands/github
+    tag:
+      example: bootstrap/journal-bookmark
+  features:
+    - navigation.indexes
+    - navigation.footer
+    - navigation.tabs
+    - navigation.tabs.sticky
+    - toc.follow
+plugins:
+  - tags:
+      tags_file: tags.md
+  - search
+extra:
+  homepage: https://attila-balint-kul.github.io/energy-forecast-benchmark-toolkit
+  consent:
+    title: Cookie consent
+    description: >-
+      We use cookies to recognize your repeated visits and preferences, as well
+      as to measure the effectiveness of our documentation and whether users
+      find what they're searching for. With your consent, you're helping us to
+      make our documentation better.
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/attila-balint-kul/energy-forecast-benchmark-toolkit
+  tags:
+    Examples: example
+nav:
+  - Home: index.md
+  - Getting Started: getting-started.md