Merge remote-tracking branch 'origin/master' into 313_permit_intrinsi…

…c_shadowing

doc/pip_requirements.txt → .readthedocs.yaml

@@ -1,7 +1,7 @@
 # -----------------------------------------------------------------------------
 # BSD 3-Clause License
 #
-# Copyright (c) 2022-2023, Science and Technology Facilities Council.
+# Copyright (c) 2024, Science and Technology Facilities Council.
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -32,10 +32,32 @@
 # POSSIBILITY OF SUCH DAMAGE.
 # -----------------------------------------------------------------------------
 
-# pip requirements file specifying the packages required to build
-# the fparser documentation. Used by readthedocs.
-sphinx
-sphinxcontrib.bibtex
-autoapi
-sphinx-autoapi
-sphinx_rtd_theme
+# Read the Docs configuration file for the fparser documentation
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details.
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+  apt_packages:
+    - graphviz
+
+# Build documentation in the doc/source directory with Sphinx
+sphinx:
+   configuration: doc/source/conf.py
+
+# If using Sphinx, optionally build your docs in additional formats such as PDF
+# formats:
+#    - pdf
+
+# Optionally declare the Python requirements required to build your docs.
+python:
+   install:
+     - method: pip
+       path: .
+       extra_requirements:
+         - doc

CHANGELOG.md

@@ -18,6 +18,8 @@ Modifications by (in alphabetical order):
 * P. Vitt, University of Siegen, Germany
 * A. Voysey, UK Met Office
 
+11/01/2024 PR #439 for #432. Fix RTD build and clean up setuptools config.
+
 03/10/2023 PR #431 for #430. Fixes bug in WHERE handling in fparser1.
 
 14/09/2023 PR #425 for #411. Splits the monolithic Fortran2008.py file

doc/Makefile

@@ -21,6 +21,7 @@ help:
 
 # Target that removes all generated files
 allclean: clean
-	@echo "Removing everything under 'source'..."
+	@echo "Removing everything under 'source/autoapi'..."
 	@rm -rf ./source/autoapi/*
+	@echo "Removing everything under 'source/doxygen'..."
 	@rm -rf ./source/doxygen/*

doc/source/conf.py

@@ -6,13 +6,14 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 import subprocess
+import fparser
 
 project = 'fparser'
-copyright = '2017-2022, Science and Technology Facilities Council'
+copyright = '2017-2024, Science and Technology Facilities Council'
 author = 'Andrew Porter, Rupert Ford, Balthasar Reuter and Pearu Peterson'
 
-version = '0.0.16'
-release = '0.0.16'
+version = fparser._get_version()
+release = fparser._get_version()
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

pyproject.toml

@@ -1,11 +1,46 @@
 [build-system]
 requires = [
-    "setuptools >= 42",
+    "setuptools >= 61",
     "setuptools_scm[toml] >= 6.2",
     "setuptools_scm_git_archive",
     "wheel >= 0.29.0",
 ]
 build-backend = "setuptools.build_meta"
 
+[project]
+name = "fparser"
+authors = [{name = "Pearu Peterson"},
+	   {name = "Rupert Ford"},
+	   {name = "Andrew Porter", email = "[email protected]"}]
+license = {text = "BSD-3-Clause"}
+description = "Python implementation of a Fortran parser"
+readme = "README.md"
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "Natural Language :: English",
+    "Programming Language :: Fortran",
+    "Programming Language :: Python",
+    "Topic :: Scientific/Engineering",
+    "Topic :: Software Development",
+    "Topic :: Utilities",
+    "Operating System :: POSIX",
+    "Operating System :: Unix",
+    "Operating System :: MacOS",
+]
+keywords = ["fortran", "parser"]
+dynamic = ["version"]
+requires-python = ">=3.6"
+dependencies = ["setuptools_scm"]
+
+[project.optional-dependencies]
+doc = ["sphinx", "sphinxcontrib.bibtex", "autoapi", "sphinx-autoapi", "sphinx_rtd_theme"]
+tests = ["pytest >= 3.3.0"]
+
+[project.scripts]
+fparser2 = "fparser.scripts.fparser2:main"
+
 [tool.setuptools_scm]
 write_to = "src/fparser/_version.py"