Migrating docs away from readthedocs

Author: ndejong

.github/workflows/build-tests.yml

@@ -1,6 +1,10 @@
 
 name: build tests
-on: [push]
+
+on:
+  push:
+    branches: [ '*' ]
+    tags: [ '*' ]
 
 jobs:
 
@@ -9,14 +13,14 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
     steps:
     - uses: actions/checkout@v4
     - uses: NiklasRosenstein/slap@gha/install/v1
-      with: { version: "1.12.0" }
+      with: { version: "1.15.0" }
 
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with: { python-version: "${{ matrix.python-version }}" }
 
     - name: Create a venv to operate within using slap-cli

.github/workflows/docs.yml

@@ -0,0 +1,38 @@
+
+name: docs
+
+on:
+  push:
+    branches: [ 'main', 'dev' ]
+
+env:
+  PYTHON_VERSION: "3.12"
+
+permissions:
+  contents: write
+
+jobs:
+
+  docs:
+    runs-on: ubuntu-latest
+    environment: github-pages
+
+    steps:
+      - name: Checkout latest
+        uses: actions/checkout@v4
+        with: { fetch-depth: 0 }
+      - name: Install Python
+        uses: actions/setup-python@v5
+        with: { python-version: "3.12" }
+      - name: Install UV
+        uses: astral-sh/setup-uv@v5
+      - name: Install project using UV
+        run: |
+          cd docs
+          uv tool install . || exit 0
+        # NB: until uv is able to handle packages without executables we need to use an " || exit 0"
+      - name: Build docs and publish
+        run: |
+          cd docs
+          uv run --active -- bash -xc 'mkdocs --version'
+          uv run --active -- bash -xc 'mkdocs gh-deploy --force'

.readthedocs.yml

@@ -3,7 +3,6 @@
 [![pypi](https://img.shields.io/pypi/v/hibp-downloader.svg)](https://pypi.python.org/pypi/hibp-downloader/)
 [![python](https://img.shields.io/pypi/pyversions/hibp-downloader.svg)](https://github.com/threatpatrols/hibp-downloader/)
 [![build tests](https://github.com/threatpatrols/hibp-downloader/actions/workflows/build-tests.yml/badge.svg)](https://github.com/threatpatrols/hibp-downloader/actions/workflows/build-tests.yml)
-[![docs](https://img.shields.io/readthedocs/hibp-downloader)](https://hibp-downloader.readthedocs.io)
 [![license](https://img.shields.io/github/license/threatpatrols/hibp-downloader.svg)](https://github.com/threatpatrols/hibp-downloader)
 
 This is a CLI tool to efficiently download a local copy of the pwned password hash data from the very awesome
@@ -58,15 +57,6 @@ Sample download activity log; host with 32 cores on 500Mbit/s connection.
 
 ## Project
 
- - Github - [github.com/threatpatrols/hibp-downloader](https://github.com/threatpatrols/hibp-downloader)
+ - Docs - [threatpatrols.github.io/hibp-downloader](https://threatpatrols.github.io/hibp-downloader)
  - PyPI - [pypi.org/project/hibp-downloader/](https://pypi.org/project/hibp-downloader/)
- - ReadTheDocs - [hibp-downloader.readthedocs.io](https://hibp-downloader.readthedocs.io)
-
-## Copyright
- - Copyright © 2023-2024 [Threat Patrols Pty Ltd](https://www.threatpatrols.com)
- - Copyright © 2023-2024 [Nicholas de Jong](https://www.nicholasdejong.com)
-
-All rights reserved.
-
-## License
- * BSD-3-Clause - see LICENSE file for details.
+ - Github - [github.com/threatpatrols/hibp-downloader](https://github.com/threatpatrols/hibp-downloader)

README.md

@@ -0,0 +1 @@
+3.12