Merge pull request #167 from metabrainz/pyproject

Migrate to pyproject.toml and fix docs build

Author: yvanzo

setup.cfg .flake8setup.cfg renamed to .flake8

@@ -12,4 +12,6 @@ formats: all
 
 python:
    install:
-   - requirements: requirements.txt
+   - requirements: docs/requirements.txt
+   - method: pip
+     path: .

docs/.readthedocs.yaml

@@ -0,0 +1,3 @@
+sphinx==8.2.3
+sphinx-rtd-theme==3.0.2
+-r ../requirements.txt

docs/requirements.txt

@@ -51,8 +51,8 @@
 master_doc = 'index'
 
 # General information about the project.
-project = u'sir'
-copyright = u'2014 Wieland Hoffmann'
+project = 'sir'
+copyright = '2014-2016, Wieland Hoffmann; 2017-2025 MetaBrainz Foundation'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -103,27 +103,8 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'default'
-
-# Theme options are theme-specific and customize the look and feel of a theme
-# further.  For a list of options available for each theme, see the
-# documentation.
-html_theme_options = {
-        "footerbgcolor": "#e7e7e7",
-        "footertextcolor": "#444444",
-        "sidebarbgcolor": "#ffffff",
-        "sidebartextcolor": "#000000",
-        "sidebarlinkcolor": "002bba",
-        "relbarbgcolor": "#5c5789",
-        "relbartextcolor": "#000000",
-        "bgcolor": "#ffffff",
-        "textcolor": "#000000",
-        "linkcolor": "#002bba",
-        "headbgcolor": "#ffba58",
-        "headtextcolor": "#515151",
-        "codebgcolor": "#dddddd",
-        "codetextcolor": "#000000"
-        }
+import sphinx_rtd_theme
+html_theme = 'sphinx_rtd_theme'
 
 # Add any paths that contain custom themes here, relative to this directory.
 #html_theme_path = []
@@ -205,8 +186,8 @@
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-  ('index', 'sir.tex', u'sir Documentation',
-   u'Wieland Hoffmann', 'manual'),
+  ('index', 'sir.tex', 'sir Documentation',
+   'MetaBrainz Foundation \and Wieland Hoffman', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -238,6 +219,6 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'sir', u'sir Documentation',
-     [u'Wieland Hoffmann'], 1)
+    ('index', 'sir', 'sir Documentation',
+     ['MetaBrainz Foundation', 'Wieland Hoffmann'], 1)
 ]

docs/source/conf.py

@@ -0,0 +1,36 @@
+[project]
+name = "sir"
+description="Search Index Rabbit"
+authors = [
+    { name = "MetaBrainz Foundation", email = "support@metabrainz.org" },
+    { name = "Wieland Hoffmann" }
+]
+readme = "README.rst"
+license = "MIT"
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3.13"
+]
+dynamic = ["version"]
+
+[project.urls]
+Issues = "https://tickets.metabrainz.org/projects/SEARCH/issues/"
+Documentation = "https://sir.readthedocs.io"
+Repository = "https://github.com/metabrainz/sir"
+
+[build-system]
+requires = ["setuptools>=80.3.1", "setuptools_scm>=8.3.1"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+packages = [
+    "sir",
+    "sir.amqp",
+    "sir.schema",
+    "sir.trigger_generation",
+    "sir.wscompat"
+]
+
+[tool.setuptools_scm]

pyproject.toml

@@ -1,8 +1,9 @@
+from importlib.metadata import version, PackageNotFoundError
+
 try:
-    # Version is required only for generating the documentation
-    from .version import __version__  # noqa
-except ImportError:
-    __version__ = None
+    __version__ = version("sir")
+except PackageNotFoundError:
+    pass
 
 import sentry_sdk