docs: added docs to github pages

.github/workflows/publish_docs.yml

@@ -0,0 +1,76 @@
+name: Publish Docs to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  publish:
+    strategy:
+      matrix:
+        python-version: [3.11]
+    defaults:
+      run:
+        shell: bash
+    environment: ${{ github.base_ref }}
+    runs-on: ubuntu-latest
+    steps:
+      #----------------------------------------------
+      #   ----------- check-out repo  ------------
+      #----------------------------------------------
+      - uses: actions/checkout@v4
+
+      #----------------------------------------------
+      #   ------------  setup python  -----------
+      #----------------------------------------------
+      - name: 🔧 Setup Python
+        id: setup-python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      #----------------------------------------------
+      #  -----  install & configure poetry  -----
+      #----------------------------------------------
+      - name: 📜 Install Poetry
+        run: |
+          python -m pip install -U pip poetry
+          poetry --version
+
+      #----------------------------------
+      #  -----  load cached venv  -----
+      #----------------------------------
+      - name: Load cached venv
+        id: cached-pip-wheels
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache
+          key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}
+
+      #----------------------------------------------
+      #   ------------  install deps  ------------
+      #----------------------------------------------
+      - name: Install dependencies
+        run: |
+          poetry install --no-interaction
+
+      #-----------------------------------------------------
+      #   ------------  configure mkdocs cache  ------------
+      #-----------------------------------------------------
+      - name: Set mkdocs cache_id
+        run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - name: Load cached mkdocs
+        id: cached-mkdocs
+        uses: actions/cache@v4
+        with:
+          key: mkdocs-metrial-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-metrial-
+        
+      #------------------------------------------------
+      #   ------------  build and publish  ------------
+      #------------------------------------------------
+      - name: Build and publish docs
+        run: make publish-docs

.github/workflows/publish.yml → .github/workflows/publish_pypi.yml

@@ -61,4 +61,4 @@ jobs:
       - name: Build and publish
         env:
           PYPI_API_TOKEN: ${{ secrets.PYPI_API_TOKEN }}
-        run: make publish
+        run: make publish-pypi

.gitignore

@@ -12,4 +12,5 @@ test_init.py
 .pytest_cache
 .ruff_cache
 .coverage*
-coverage.xml
+coverage.xml
+site

Makefile

@@ -64,8 +64,13 @@ push:
 	@git push
 	@echo "Changes pushed!"
 
-### Commands to publish the package ###
-publish:
-	@echo "Publishing package..."
-	@/bin/bash -c "scripts/publish.sh"
-	@echo "Package published!"
+### Commands to publish the project components ###
+publish-pypi:
+	@echo "Publishing package to PyPi..."
+	@/bin/bash -c "scripts/publish_pkg.sh"
+	@echo "Package published!"
+
+publish-docs:
+	@echo "Publishing documentation..."
+	@/bin/bash -c "scripts/publish_docs.sh"
+	@echo "Documentation published!"

docs/about.md

@@ -0,0 +1,76 @@
+# At dei
+
+## Moveri iusserat
+
+Lorem markdownum enim depositoque ullum: laeva ubi. Unus est traderet nunc
+novissima mollibus mixta ut a in se medicamine corpore Iunonem sollertior
+indicet est molles foret fecunda. Vos Adoni, que Achivi, pinguescere veterum
+[parens quasque](http://www.pugnem.com/ab) dicentem sit vitalesque possum, es.
+
+    cyberspace(document_c_emoticon(cursorDynamic(runtime_video, refreshIpod,
+            backupMonochromePoint)), 1, symbolic_sprite(
+            halftoneReciprocalNetwork(sampling), -4 + favicon_target_wpa,
+            bar_perl));
+    if (betaP + 1 + panelToslink(-4, fat_ups, sourceCadPlain) >=
+            trinitronPlug) {
+        kilobit.edi = refreshPrimaryHdd;
+        pda_bar.exbibyteAnsi = -2;
+        caps_status_png = leaderboard;
+    }
+    var error = architecture - eupActive + 2;
+    if (dvr) {
+        irc(-1);
+        dvd.pipeline_recursion_recursive(ppiFirmwareIo, scanner.bittorrent_ups(
+                titleActive, moduleBotnet));
+        smm_edutainment_cloud += pup;
+    } else {
+        refresh_registry_cmos += outputPlain;
+        userPlugNetbios = data;
+        koffice /= 3;
+    }
+
+Inductus mihi, per animo aliena, nisi nec Latona [rauca
+comitesque](http://www.monstritrahoque.io/inviautrumque), quam cum Haemoniae
+vulnere. Litus sua illa felixque suorum de concepit quondam fulsit condebat
+subit Oebalide optime stabulorum esse per virum. Inde *peti aequora in* Europa
+nutrix Cyllenide, tamen sparsisque quidam nullam.
+
+## Bracchia mihi quamquam omnis illis ambage
+
+Et **gregibus** extulit, in sit, *cepere latrare partem* serta; fitque videri
+commenta ferae [in Phoebus](http://utere.net/suis.html), silentia. Misit ipsi
+laevane rapta, exsiccata tum voce timeto et, Cecropide signa munus raptae.
+Onusque per modo queruntur *adorat virgo* imagine sanguinis longius sorores? Qua
+Ilus ademptas nostrasque in petit et metus in gerat spectatas futuri ad edita.
+
+1. Paravi sole picae copia spem
+2. Toro adde grandior lignoque Athon mentiturque ante
+3. Adhuc dicunt
+4. Et inque agendum pereuntem succedere Aenean addit
+
+## Areos probavit crescere notus tanti iugulo
+
+[Currus](http://www.eststipes.org/) racemis et, et cura nec saevis Pyrrha, fit.
+Correpta ad timoris hostisque fretum non, soli citius loci? Mea cladibus
+**tempora conpositas** ureris statque: munera! Nos cum suo **sub** male maioris
+deinde.
+
+1. Fugio ut poposcit testantur susurro sibi
+2. Tectaque sed proximitas inque maior non inquit
+3. Dixit deque me Ante intrare Liber quos
+4. Inpia pariterque meri
+
+Positisque casus amore; serpentis clamor quidem moriturus cadunt vicisti abiit,
+voce prodere, me. Quem instructa recingunt glacies nimiumque petit, Agamemnona
+si ripa potui utendum tenuantur obliquis ferret quae iacit! Lunaribus
+[enumerare](http://poena.io/ore.html), quid suscitat tristis conripiantque habet
+comminus at patris natisque
+[frustra](http://www.aequoreos-cernit.io/sopita-amictu) neque: quasque ait
+pectusque. Sed coniunx credula flammis pascere laevaque mare sororis matrona;
+**nam** geminas *in piceis* mentum. Fortibus simul turbinis terrigenae sub, ex
+dum recenti **omnes sponda** silvas, vestros, ab ferat **Pelea**.
+
+Eurytus inscius consonat agros **simulavimus** quidam animus accipiunt effugiam
+e tantum, reflectunt. Suo sedant auras nova tanta vestra incingitur puer: tu
+collo nam est. Lycia et quod Tagen dicet sanet missa pallidaque in pressit
+novoque equorum fata aequora ille qui deduxit parens, recondiderat.

docs/index.md

@@ -0,0 +1,17 @@
+# Welcome to MkDocs
+
+For full documentation visit [mkdocs.org](https://www.mkdocs.org).
+
+## 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.

mkdocs.yml

@@ -0,0 +1,11 @@
+site_name: PyRevolut
+site_description: "PyRevolut is a Python wrapper for the Revolut Business API."
+site_author: "Trevor Visser"
+docs_dir: docs/
+repo_name: "Trevypants/pyrevolut"
+repo_url: "https://github.com/Trevypants/pyrevolut"
+nav:
+  - Home: index.md
+  - About: about.md
+theme: 
+  name: material