Skip to content

Commit 6849f36

Browse files
committed
Update version to 0.1.0
Documentation updated to reflect the pre-1.0.0 status
1 parent 07a0acd commit 6849f36

4 files changed

Lines changed: 30 additions & 10 deletions

File tree

docs/changelog.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
.. _changelog:
2+
3+
.. include:: ../CHANGELOG.rst

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
# The short X.Y version
3636
version = "0.1"
3737
# The full version, including alpha/beta/rc tags
38-
release = "0.1.0-alpha.4"
38+
release = "0.1.0"
3939

4040

4141
# -- General configuration ---------------------------------------------------

docs/index.rst

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
11
MiniZinc Python
22
===============
33

4-
.. warning::
5-
The development of MiniZinc Python is still in the very early stages. We
6-
appreciate any feedback for the package, but we would recommend refraining
7-
from using the package in production software. The package can drastically
8-
change and backwards compatible changes are not guaranteed.
9-
104
MiniZinc Python provides a native python interface for the MiniZinc toolchain.
115
The package can interface with MiniZinc in two ways: using the command line
126
interface, the ``minizinc`` executable, or the experimental C API to MiniZinc
@@ -17,6 +11,19 @@ new ways! Using MiniZinc in a procedural language allows you to use incremental
1711
solving techniques that can be used to implement different kinds of
1812
meta-heuristics.
1913

14+
.. note::
15+
16+
The development of MiniZinc Python is still in its early stages. Although
17+
the module is fully supported and the functionality is stabilising, we
18+
will not guarantee that changes made before version 1.0 are backwards
19+
compatible. Similarly, the functionality of this module is closely
20+
connected to the releases of the main MiniZinc bundle. An update to this
21+
module might require an update to your MiniZinc installation.
22+
23+
This project adheres to `Semantic Versioning <https://semver.org>`_ and
24+
all (breaking) changes are recorded in the :ref:`changelog <changelog>`.
25+
26+
2027
Documentation
2128
-------------
2229

@@ -41,3 +48,13 @@ this part of the documentation is for you.
4148
:maxdepth: 2
4249

4350
api
51+
52+
Changelog
53+
---------
54+
55+
All changes made to this project are recorded in the changelog.
56+
57+
.. toctree::
58+
:maxdepth: 1
59+
60+
changelog

pyproject.toml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ line_length = 88
1414

1515
[tool.poetry]
1616
name = "minizinc"
17-
version = "0.1.0-alpha.4"
17+
version = "0.1.0"
1818
description = "Access MiniZinc directly from Python"
1919
readme = "README.md"
2020
authors = ["Jip J. Dekker <[email protected]>"]
@@ -23,7 +23,7 @@ homepage = "https://www.minizinc.org/"
2323
documentation = "https://minizinc-python.readthedocs.io"
2424
repository = "https://gitlab.com/minizinc/minizinc-python"
2525
classifiers=[
26-
"Development Status :: 3 - Alpha",
26+
"Development Status :: 4 - Beta",
2727
"Operating System :: OS Independent",
2828
"Topic :: Scientific/Engineering :: Artificial Intelligence",
2929
"Topic :: Scientific/Engineering :: Mathematics",
@@ -44,4 +44,4 @@ flake8-bugbear = "^19.8"
4444
flake8-mypy = "^17.8"
4545
isort = {version = "^4.3", extras = ["pyproject"]}
4646
pytest = "^5.1"
47-
tox = "^3.14"
47+
tox = "^3.14"

0 commit comments

Comments
 (0)