From 1151334c45d93b8ef7cb5e6756de0bbf0a759257 Mon Sep 17 00:00:00 2001 From: Alexander Nasuta <alexander.nasuta@ima.rwth-aachen.de> Date: Thu, 20 Mar 2025 17:58:25 +0100 Subject: [PATCH] v1.0.3 --- LICENSE | 2 +- README.md | 2 ++ docs/source/conf.py | 4 ++-- docs/source/usage.md | 6 +++--- pyproject.toml | 13 ++++++++----- 5 files changed, 16 insertions(+), 11 deletions(-) diff --git a/LICENSE b/LICENSE index 25763b5..a875a39 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2024 Alexander Nasuta +Copyright (c) 2025 Alexander Nasuta Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 7b04be5..7c6773f 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,8 @@ - **PyPi**: https://pypi.org/project/jsp-instance-utils/ +- **Documentation**: https://jsp-instance-utils.readthedocs.io/en/latest/ + # About The Project This project contains all Job Shop Scheduling Problem (JSP) benchmark instances from http://jobshop.jjvh.nl/ and some utility functions to work with JSP instances. diff --git a/docs/source/conf.py b/docs/source/conf.py index 8f0dc56..2091bc2 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -9,7 +9,7 @@ project = 'jsp-instance-utils' copyright = '2025, Alexander Nasuta' author = 'Alexander Nasuta' -release = '1.0.2' +release = '1.0.3' # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration @@ -51,7 +51,7 @@ html_css_files = [ ] # Configure autosectionlabel -autosectionlabel_prefix_document = True +autosectionlabel_prefix_document = False autosectionlabel_maxdepth = 2 # Exclude specific files diff --git a/docs/source/usage.md b/docs/source/usage.md index 28d8dd9..f9131ab 100644 --- a/docs/source/usage.md +++ b/docs/source/usage.md @@ -98,7 +98,7 @@ The lowest known makespan is a {'optimal' if ft06_makespan_is_optimal else 'not This code snippet returns the following output: - + Analogously, you can load the `ta01` instance from the package and extract the machine matrix and the processing time matrix: @@ -122,8 +122,8 @@ The lowest known makespan is a {'optimal' if ta01_makespan_is_optimal else 'not This code snippet yields the following output: - + ## Reinforcement Learning Environments -For the usage of the instances in reinforcement learning environments, we provide a wrapper class that can be used to create a reinforcement learning environment please check out the {ref}`asdasd` of this project. +For the usage of the instances in reinforcement learning environments, we provide a wrapper class that can be used to create a reinforcement learning environment please check out the {ref}`Table of Instances` of this project. diff --git a/pyproject.toml b/pyproject.toml index 4e75612..37521f3 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,13 +4,12 @@ build-backend = "setuptools.build_meta" [project] name = "jsp-instance-utils" -version = "1.0.2" -description = "A package containg benchmark instances for the Job Shop Scheduling Problem (JSP) scraped from " +version = "1.0.3" +description = "A package containing benchmark instances for the Job Shop Scheduling Problem (JSP) scraped from various sources." readme = "README.md" authors = [{ name = "Alexander Nasuta", email = "alexander.nasuta@wzl-iqs.rwth-aachen.de" }] -license = { file = "LICENSE" } +license = { text = "MIT", expression = "MIT" } classifiers = [ - "License :: OSI Approved :: MIT License", "Programming Language :: Python", "Programming Language :: Python :: 3", ] @@ -22,7 +21,11 @@ dependencies = [ "beautifulsoup4", "jsp-vis", ] -requires-python = ">=3.10" +requires-python = ">=3.11" + +[tool.setuptools] +license-files = [] + [project.optional-dependencies] dev = [ -- GitLab