Skip to content

Commit

Permalink
Version 1.1.0 (includes documentation update for release).
Browse files Browse the repository at this point in the history
  • Loading branch information
jatkinson1000 committed Nov 16, 2024
1 parent dab41e7 commit 29e2451
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 12 deletions.
4 changes: 2 additions & 2 deletions docs/community/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ The SSI provides `good guidance <https://www.software.ac.uk/publication/how-cite

The following entries can be used or adapted when citing this work:

* Atkinson J., archeryutils python package [v1.0.0] (2024); software available at https://github.com/jatkinson1000/archeryutils.
* Atkinson J., archeryutils python package [v1.1.0] (2024); software available at https://github.com/jatkinson1000/archeryutils.
* BibTeX::

@Manual{archeryutils,
author = {Atkinson, J},
title = {archeryutils python package, Version~1.0.0},
title = {archeryutils python package, Version~1.1.0},
year = {2024},
url = {https://github.com/jatkinson1000/archeryutils},
}
Expand Down
2 changes: 1 addition & 1 deletion docs/develop/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ archeryutils is an open-source community project currently operating as a

Contributions from anyone are welcome, be they bug reports, bug fixes,
features/enhancements, documentation improvements etc.
For details of how to get involved with any of these see :ref:`contributing`.`
For details of how to get involved with any of these see :ref:`contributing`.



Expand Down
18 changes: 18 additions & 0 deletions docs/develop/whats-new.rst
Original file line number Diff line number Diff line change
@@ -1,2 +1,20 @@
What's New
==========

Version 1.1.0
-------------
* Updated field classifications to the 2025 Archery GB scheme:

* Uses new age groups, rounds, classifications and scores
* For full details see `archerycalculator.co.uk/new-field <https://archerycalculator.co.uk/new-field>`_
* Added option to use "English Longbow" as a bowstyle alias
* Old field classifications archived but still available using ``old`` in the function calls. See `related API documentation <https://archeryutils.readthedocs.io/en/latest/api/archeryutils.classifications.html#archeryutils.classifications.old_agb_field_classification_scores>`_

* Test suite extended to cover Python 3.13
* Linting moved to use ruff v0.7.3
* Coverage workflows updated to latest versions


Version 1.0.0
-------------
* Initial release of archeryutils.
10 changes: 4 additions & 6 deletions docs/getting-started/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,16 +54,12 @@ lint

For applying quality control to the code::

pip install -e ".[lint]"

* black (24.1.0 or later)
* jupyter-black
* pylint
* ruff (0.7.3 or later)
* mypy (1.0.0 or later)
* coverage
* pytest (7.2.0 or later)
* pytest-mock
* pydocstyle
* blackdoc

docs
^^^^
Expand All @@ -78,3 +74,5 @@ For building documentation::
* nbsphinx
* blackdoc
* ipython
* pickleshare
* ruff (0.7.3 or later)
6 changes: 3 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"

[project]
name = "archeryutils"
version = "1.0.0"
version = "1.1.0"
description = "A collection of archery utilities in python."
authors = [
{ name="Jack Atkinson", email="[email protected]" },
Expand Down Expand Up @@ -39,7 +39,7 @@ lint = [
"coverage",
"pytest>=7.2.0",
"pytest-mock",
"ruff>=0.3.0",
"ruff>=0.7.3",
"blackdoc",
]
docs = [
Expand All @@ -49,7 +49,7 @@ docs = [
"nbsphinx",
"ipython",
"pickleshare", # https://github.com/ipython/ipython/issues/14237
"ruff>=0.3.0",
"ruff>=0.7.3",
"blackdoc",
]

Expand Down

0 comments on commit 29e2451

Please sign in to comment.