From cb1f40245fbdf8eb24a86e99031e69148b5a0e91 Mon Sep 17 00:00:00 2001 From: Pascal Date: Sun, 9 Nov 2025 12:51:03 +0100 Subject: [PATCH 1/3] Added readthedocs config and requirements. --- .readthedocs.yaml | 23 +++++++++++++++++++++++ docs/requirements.txt | 5 +++++ 2 files changed, 28 insertions(+) create mode 100644 .readthedocs.yaml create mode 100644 docs/requirements.txt diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..66fe41e --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,23 @@ +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the OS, Python version, and other tools you might need +build: + os: ubuntu-24.04 + tools: + python: "3.11" + +# Build documentation in the "docs/" directory with Sphinx +sphinx: + configuration: docs/conf.py + + +# Optionally, but recommended, +# declare the Python requirements required to build your documentation +# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html +python: + install: + - requirements: docs/requirements.txt diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..3ffc602 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,5 @@ +sphinx==8.2.3 +sphinx-autodoc-typehints==3.1.0 +furo==2024.8.6 +myst-parser==4.0.1 +sphinx-new-tab-link==0.8.0 \ No newline at end of file From 8a7add1f9aedba3d746b77057970a650e920140b Mon Sep 17 00:00:00 2001 From: Pascal Date: Sun, 9 Nov 2025 12:53:11 +0100 Subject: [PATCH 2/3] Fix sphinx config path. --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 66fe41e..6e6a6e1 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -12,7 +12,7 @@ build: # Build documentation in the "docs/" directory with Sphinx sphinx: - configuration: docs/conf.py + configuration: docs/source/conf.py # Optionally, but recommended, From 5b3b0561f9601756382da44066a2d6a33a2bc63b Mon Sep 17 00:00:00 2001 From: Pascal Date: Sun, 9 Nov 2025 13:00:49 +0100 Subject: [PATCH 3/3] Updated CHANGELOG.md and version to 4.0.1. --- CHANGELOG.md | 14 ++++++++------ pyproject.toml | 3 ++- 2 files changed, 10 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 89ab43e..001ed92 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -16,6 +16,14 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ### Fixed +## [4.0.1] - 2025-11-09 + +### Added + +- GitHub workflow to run tests upon push +- Issue templates for bug reports and feature requests. +- readthedocs configuration file and requirements. + ## [4.0.0] - 2025-10-28 ### Added @@ -32,14 +40,10 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). - Column `major_round` depicting major stock and operating rounds. - Poetry script called `trx` to have main script available after installation. -### Changed - ### Removed - Public functions to access metadata information. Moved to transcript context. -### Fixed - ## [3.0.0] - 2025-09-14 ### Added @@ -58,8 +62,6 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). - Start capital of Games18xx denote starting capital of each player and not the sum that is divided. -### Removed - ### Fixed - Regex pattern for GameOver: Detects everything up to the next comma (including diff --git a/pyproject.toml b/pyproject.toml index 52c6142..e575a23 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,9 +1,10 @@ [tool.poetry] name = "transcripts18xx" -version = "4.0.0" +version = "4.0.1" description = "A Python package to preprocess game transcripts from 18xx.games" authors = ["Pascal "] readme = "README.md" +license = "MIT" [tool.poetry.dependencies] python = "^3.11"