diff --git a/CHANGELOG.md b/CHANGELOG.md index 708ac4a..03f34da 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,7 +2,7 @@ All notable changes to this project will be documented here. For a list of contributors, see the -[Contributors](https://mmh3.readthedocs.io/en/latest/CONTRIBUTORS.html) page. +[Contributors](https://mmh3.readthedocs.io/en/stable/CONTRIBUTORS.html) page. The format is based on [Keep a Changelog 1.1.0](https://keepachangelog.com/en/1.1.0/). diff --git a/LICENSE b/LICENSE index 8848f0c..f7d8a65 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2011-2024 Hajime Senuma +Copyright (c) 2011-2025 Hajime Senuma 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 e49d088..1245e7a 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ which are utilized by [Shodan](https://www.shodan.io), the world's first IoT search engine. This page provides a quick start guide. For more comprehensive information, -please refer to the [documentation](https://mmh3.readthedocs.io/en/latest/). +please refer to the [documentation](https://mmh3.readthedocs.io/en/stable/). ## Installation @@ -67,19 +67,19 @@ b'\x8c\xee\xc6z\xa9\xfeR\xe8o\x9a\x9b\x17u\xbe\xdc\xee' Various alternatives are available, offering different return types (e.g., signed integers, tuples of unsigned integers) and optimized for different architectures. For a comprehensive list of functions, refer to the -[API Reference](https://mmh3.readthedocs.io/en/latest/api.html). +[API Reference](https://mmh3.readthedocs.io/en/stable/api.html). ### `hashlib`-style hashers `mmh3` implements hasher objects with interfaces similar to those in `hashlib` from the standard library, although they are still experimental. See -[Hasher Classes](https://mmh3.readthedocs.io/en/latest/api.html#hasher-classes) +[Hasher Classes](https://mmh3.readthedocs.io/en/stable/api.html#hasher-classes) in the API Reference for more information. ## Changelog -See [Changelog](https://mmh3.readthedocs.io/en/latest/changelog.html) for the -complete changelog. +See [Changelog](https://mmh3.readthedocs.io/en/latest/changelog.html) +(latest version) for the complete changelog. ### [5.1.0] - 2025-01-25 @@ -211,7 +211,7 @@ precompute the unsigned value for simplicity. ## Contributing Guidelines -See [Contributing](https://mmh3.readthedocs.io/en/latest/CONTRIBUTING.html). +See [Contributing](https://mmh3.readthedocs.io/en/stable/CONTRIBUTING.html). ## Authors diff --git a/docs/api.md b/docs/api.md index 625b33b..b138c1f 100644 --- a/docs/api.md +++ b/docs/api.md @@ -66,7 +66,7 @@ in Python 3.12. For earlier Python versions, `mmh3` uses a type alias for the type hint [\_typeshed.ReadableBuffer](https://github.com/python/typeshed/blob/d326c9bd424ad60c2b63c2ca1c5c1006c61c3562/stdlib/_typeshed/__init__.pyi#L281), which is itself an alias for -[typing_extensions.Buffer](https://typing-extensions.readthedocs.io/en/latest/#typing_extensions.Buffer), +[typing_extensions.Buffer](https://typing-extensions.readthedocs.io/en/stable/#typing_extensions.Buffer), the backported type hint for `collections.abc.Buffer`. ``` diff --git a/docs/conf.py b/docs/conf.py index 28124a9..a06b2f6 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -11,7 +11,7 @@ # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information project = "mmh3" -project_copyright = "2011-2024, Hajime Senuma" +project_copyright = "2011-2025, Hajime Senuma" author = "Hajime Senuma" # -- General configuration --------------------------------------------------- diff --git a/paper/paper.md b/paper/paper.md index 8b49d23..980ab32 100644 --- a/paper/paper.md +++ b/paper/paper.md @@ -140,7 +140,7 @@ smaller inputs (common scenarios for non-cryptographic hashes), due to its use of `METH_FASTCALL`, an overhead-reducing interface introduced in Python 3.7. For details, see the documentation of the project: -. +. Additionally, the benchmarking results are publicly available as JSON files in the repository: .