Skip to content

Feature/readthedocs #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
codePascal merged 3 commits into from
Nov 9, 2025
Merged

Feature/readthedocs #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cb1f402
Added readthedocs config and requirements.
codePascal Nov 9, 2025
8a7add1
Fix sphinx config path.
codePascal Nov 9, 2025
5b3b056
Updated CHANGELOG.md and version to 4.0.1.
codePascal Nov 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions .readthedocs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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/source/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
14 changes: 8 additions & 6 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down
5 changes: 5 additions & 0 deletions docs/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
3 changes: 2 additions & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 <mup0117@gmail.com>"]
readme = "README.md"
license = "MIT"

[tool.poetry.dependencies]
python = "^3.11"
Expand Down