Release v1.9.0 (#166)

* bump version refs to `1.9.0`

* docs: some simplifications in the rational points docs

* refactor: simplify constructor signatures in rational point class and superclasses

* chore: remove trackgit badge from README

* docs: tweak some rational points docstrings

* docs: simplifications

* refactor: rename the `RationalPoint` lattice method (to `is_integral_lattice_point`)

* docs: further simplifications in the rational points docs

* feat: add non-zero scalar division to `RationalPoint`

* docs: clean up contributions page + MD + other fixes and clarifications

* chore(deps): update all dev. + docs deps

* docs: fix some comments in `lib` and `sequences`

* docs: some more fixes + update citation file

Author: sr-murthy

CITATION.cff

@@ -28,5 +28,5 @@ keywords:
   - sequences
 
 license: MPL-2.0
-version: 1.8.0
-date-released: 2025-10-16
+version: 1.9.0
+date-released: 2025-10-25

CONTRIBUTING.md

@@ -5,27 +5,29 @@ google-site-verification
 
 Contributors and contributions are welcome. Please read these guidelines first.
 
-## Git
+## Git `github`
 
 The project homepage is on [GitHub](https://github.com/sr-murthy/continuedfractions).
 
-Contributors can open pull requests from a fork targeting the parent `main` [branch](https://github.com/sr-murthy/continuedfractions/tree/main). But it may be a good first step to create an
-[issue](https://github.com/sr-murthy/continuedfractions/issues) or open a [discussion topic](https://github.com/sr-murthy/continuedfractions/discussions).
+Contributors can open pull requests from a fork targeting the parent `main`[branch](https://github.com/sr-murthy/continuedfractions/tree/main). But it may be a good first step to create an [issue](https://github.com/sr-murthy/continuedfractions/issues) or open
+a [discussion topic](https://github.com/sr-murthy/continuedfractions/discussions).
 
-## Repo
+## Repo `folder`
 
 You will need to clone the repository first. As there are no dependencies there isn't much to set up, so this should be pretty simple. The minimum recommended version of Python is 3.10 as some of the type hinting may be incompatible with earlier versions.
 
-## Dependencies & PDM
+## Dependencies `cubes`
 
-The package uses only standard libraries, and no third party libraries are used. See the [project TOML](https://github.com/sr-murthy/continuedfractions/blob/main/pyproject.toml) for more information.
+Only standard libraries are used. See the [project TOML](https://github.com/sr-murthy/continuedfractions/blob/main/pyproject.toml)
+for more information.
 
-Some development dependencies are specified in the `[tool.pdm.dev-dependencies]` section of the TOML including some
-`'test'` dependencies, such as [pytest](https://docs.pytest.org/en/8.0.x/) and [pytest-cov](https://pytest-cov.readthedocs.io/).
+Development dependencies are specified in the `[tool.pdm.dev-dependencies]` section of the TOML but these are purely indicative.
 
-[PDM](https://pdm-project.org/latest) is used to manage all dependencies and publish packages to PyPI. It is also used to automate certain tasks, such as running tests, as described in the section.
+[PDM](https://pdm-project.org/latest) is used to manage all dependencies. It is also used to automate certain tasks, such as running
+tests, as described in the section.
 
-There are no root-level `requirements*.txt` files - but only a single (default, version-controlled, cross-platform) [pdm.lock](https://github.com/sr-murthy/continuedfractions/blob/main/pdm.lock) lockfile, which defines metadata for all TOML-defined development dependencies, including the currently empty set of production dependencies, and their sub-dependencies etc. This can be used to install all development dependencies, including the project itself, in editable mode where available:
+There are no root-level `requirements*.txt` files - but only a single (default, version-controlled, cross-platform)
+[pdm.lock](https://github.com/sr-murthy/continuedfractions/blob/main/pdm.lock) lockfile. The lockfile is used with PDM to install all development dependencies, including the project itself, in editable mode where available:
 
 ``` shell
 pdm install -v --dev
@@ -56,34 +58,13 @@ pdm export -v -f requirements --dev -o docs/requirements.txt
 
 For more information on PDM lockfiles and installing requirements see the [PDM documentation](https://pdm-project.org/latest/).
 
-## Tests
+## Tests `microscope`
 
-Tests are defined in the `tests` folder, and should be run with [pytest](https://pytest-cov.readthedocs.io/en/latest/).
+Tests are defined in the `tests` folder and can be run directly or via the [Makefile](https://github.com/sr-murthy/continuedfractions/blob/main/Makefile), e.g. `make unitests` will run the unit tests. Linting can be performed with `make lint`, which requires [ruff](https://docs.astral.sh/ruff/) (specified in the dev. dependencies in the TOML). The doctests can be run with `make doctests`.
 
-There is a [Makefile](https://github.com/sr-murthy/continuedfractions/blob/main/Makefile) with different targets for linting (`lint`), running doctests (`doctests`) and unit tests (`unittests`):
+## Documentation `book`
 
-``` shell
-make lint
-make unittests
-make doctests
-```
-
-Unit tests can be run all at once using `make unittests` or individually using `pytest`, e.g. running the test class for the `~continuedfractions.lib.continued_fraction_rational` function:
-
-``` shell
-python -m pytest -sv tests/units/test_lib.py::TestContinuedFractionRational
-```
-
-The doctests are intended to test the docstring code examples, but can also be considered a form of acceptance tests. They can be run all at once using `make doctests`, or individually by library using `python -m doctest`, e.g. running all the doctests in
-`~continuedfractions.sequences` (from the repo root):
-
-``` shell
-PYTHONPATH=src python -m doctest -v src/continuedfractions/sequences.py
-```
-
-## Documentation
-
-[Project documentation](https://continuedfractions.readthedocs.io/en/latest/) is defined and built using [Sphinx](https://www.sphinx-doc.org/en/master/), and deployed to [Read The Docs](https://readthedocs.org). Currently, the building and deployment steps for documentation are manual, and not automated in a CI pipeline.
+[Project documentation](https://continuedfractions.readthedocs.io/en/latest/) is written and built using [Sphinx](https://www.sphinx-doc.org/en/master/), and deployed to [Read The Docs](https://readthedocs.org).
 
 The Sphinx documentation source pages and assets are contained in the `docs/` subfolder. The HTML pages can be built locally on any branch (from the project root) using:
 
@@ -105,14 +86,11 @@ or via [PDM](https://pdm.fming.dev/latest/):
 pdm install -v --dev --no-editable --no-self
 ```
 
-## CI
+## CI `circle-play`
 
 The main CI workflows are defined in the [CI YML](https://github.com/sr-murthy/continuedfractions/blob/main/.github/workflows/ci.yml)
 and the [CodeQL Analysis YML](https://github.com/sr-murthy/continuedfractions/blob/main/.github/workflows/codeql-analysis.yml).
-Currently, pipelines for all branches include a tests stage that includes Ruff linting, unit tests,and doctests, in that order.
-
-## Versioning and Releases
 
-The latest release is `1.8.0`.
+## Versioning and Releases `upload`
 
-There is currently no dedicated pipeline for releases - both [GitHub releases](https://github.com/sr-murthy/continuedfractions/releases) and [PyPI packages](https://pypi.org/project/continuedfractions) are published manually, but both have the same version tag.
+The latest release is `1.9.0`, and releases are created, tagged and published manually, not via a workflow.

README.md

@@ -8,9 +8,6 @@
 [![License: MPL
 2.0](https://img.shields.io/badge/License-MPL_2.0-brightgreen.svg)](https://opensource.org/licenses/MPL-2.0)
 [![Docs](https://readthedocs.org/projects/continuedfractions/badge/?version=latest)](https://continuedfractions.readthedocs.io/en/latest/?badge=latest)
-<a href="https://trackgit.com">
-<img src="https://us-central1-trackgit-analytics.cloudfunctions.net/token/ping/lsudelfvcxb7f1xm6i4l" alt="trackgit-views" />
-</a>
 [![PyPI version](https://img.shields.io/pypi/v/continuedfractions?logo=python&color=41bb13)](https://pypi.org/project/continuedfractions)
 [![Downloads](https://static.pepy.tech/badge/continuedfractions)](https://pepy.tech/project/continuedfractions)
 

docs/conf.py

@@ -19,10 +19,6 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
 # -- Path setup --------------------------------------------------------------
-
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
 #
 sys.path.insert(0, os.path.abspath('.'))
 sys.path.insert(0, os.path.dirname(os.path.abspath('.')))
@@ -56,13 +52,13 @@
 # Native docs language
 language = 'en'
 
-# Minimum required version of Sphinx
+# Minimum required version of Sphinx - not required ATM
 #needs_sphinx >= '7.2.5'
 
 # Set primary domain to null
 primary_domain = None
 
-# Global substitutions
+# Global substitutions - not all used
 rst_epilog = f"""
 .. |author|                 replace:: **{author}**
 .. |copyright|              replace:: **{copyright}**
@@ -77,9 +73,8 @@
 # Publish author(s)
 show_authors = True
 
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
+# Sphinx extensions - not all are used or required, but still listed
+# in case they may be required at some point.
 extensions = ['jupyter_sphinx',
               'matplotlib.sphinxext.plot_directive',
               'myst_parser',
@@ -147,15 +142,14 @@
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-# This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = ['_build',
                     'Thumbs.db',
                     '.DS_Store',]
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
 
-# A list of prefixes that are ignored when creating the module index. (new in Sphinx 0.6)
+# A list of prefixes that are ignored when creating the module index.
 modindex_common_prefix = ["continuedfractions."]
 
 doctest_global_setup = "import continuedfractions"
@@ -184,7 +178,7 @@
     'release_target': f'https://github.com/sr-murthy/continuedfractions/releases/tag/{release}'
 }
 
-# -- Options for HTML output -------------------------------------------------
+# -- Options for HTML output ----------------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
 # General (non-theme) HTML output options
@@ -194,14 +188,14 @@
     "sources/continued-fractions": [],
     "sources/sequences": [],
     "sources/rational-points": [],
-    "sources/contributing": [],
     "sources/continuedfractions/*": ["sidebar-nav-bs"],
+    "sources/contributing": [],
 }
 
 # HTML theme options
 html_theme = 'pydata_sphinx_theme'
 html_theme_options = {
-    'collapse_navigation': True,
+    'collapse_navigation': False,
     'footer_end': ['author'],
     'footer_start': ['copyright', 'sphinx-version', 'theme-version'],
     'icon_links': [

docs/index.rst

@@ -46,8 +46,8 @@ In terms of Python versions, any version from 3.10+ should be fine on any platfo
    sources/continued-fractions
    sources/rational-points
    sources/sequences
-   sources/contributing
    sources/api-reference
+   sources/contributing
 
 Indices and tables
 ==================