Compare commits

..

6 Commits

Author SHA1 Message Date
b3ebe386dc Add mkdocs-material dependency to requirements.txt 2026-02-03 19:18:44 +01:00
15dcf09ec1 Added ability to specify the Organization object or ogranization name for harvest_readmes function.
All checks were successful
/ unit-tests (push) Successful in 52s
2025-11-20 09:29:20 +01:00
ca16f1b098 Added minimal mkdocs config.
All checks were successful
/ unit-tests (push) Successful in 36s
2025-11-15 11:46:07 +01:00
4276939f30 Converted "sk" to package. 2025-11-15 11:42:35 +01:00
15349c9390 Allow specifying Python version for virtual environment creation 2025-11-15 11:42:13 +01:00
064364caa6 Added minimal MkDocs configuration. 2025-11-15 11:42:07 +01:00
5 changed files with 12 additions and 5 deletions

View File

@@ -15,9 +15,12 @@ def sanitize_name(name: str) -> str:
"""Sanitize a name to be filesystem-friendly."""
return name.lower().replace(" ", "-").replace("_", "-")
def harvest_readmes(organization: str, branch: list[str | None] = ["main", "dev", None], projects: list[str] = [], output_path: str = "reference") -> None:
def harvest_readmes(organization: str | Organization, branch: list[str | None] = ["main", "dev", None], projects: list[str] = [], output_path: str = "reference") -> None:
"""Harvest README files from repositories."""
org = Organization("https://dev.azure.com/" + organization, token=get_token())
if isinstance(organization, str):
org = Organization("https://dev.azure.com/" + organization, token=get_token())
else:
org = organization
if projects:
# Target specific projects

View File

@@ -1,6 +1,8 @@
#! /usr/bin/env bash
python3 -m venv .venv
VERSION="${1:-3}"
python${VERSION} -m venv .venv
./.venv/bin/pip install --upgrade pip
./.venv/bin/pip install -r requirements.txt

View File

@@ -1,4 +1,4 @@
site_name: Reference
site_name: Reference Documentation
docs_dir: reference
theme:
name: material

View File

@@ -2,3 +2,4 @@ debugpy==1.8.17
azure-identity==1.25.1
requests==2.32.5
loki-logger-handler==1.1.2
mkdocs-material>=1.5.2

1
sk/__init__.py Normal file
View File

@@ -0,0 +1 @@
# My helper tools