From ccf50aacd7463d45fd19f742f1396a1cc960d37c Mon Sep 17 00:00:00 2001 From: Simon Conseil Date: Fri, 16 Oct 2026 10:37:57 +0200 Subject: [PATCH 1/5] misc updates following py315 release --- .github/workflows/python-tests.yml | 2 +- .gitlab-ci.yml | 18 +++++++++++++----- .pre-commit-config.yaml | 4 ++-- .readthedocs.yml | 4 ++-- 4 files changed, 18 insertions(+), 10 deletions(-) diff --git a/.github/workflows/python-tests.yml b/.github/workflows/python-tests.yml index bacc98bd..cbc17d34 100644 --- a/.github/workflows/python-tests.yml +++ b/.github/workflows/python-tests.yml @@ -34,7 +34,7 @@ jobs: nox_args: '--remote-data=any' - python-version: '3.14' nox_session: coverage - - python-version: '3.15-dev' + - python-version: '3.15' nox_session: tests steps: diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index e275332a..9bcbba1b 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -33,7 +33,7 @@ py311: image: python:3.11 stage: test script: - - nox -s coverage + - nox -s tests py312: extends: @@ -41,7 +41,7 @@ py312: image: python:3.12 stage: test script: - - nox -s coverage + - nox -s tests py313: extends: @@ -49,7 +49,7 @@ py313: image: python:3.13 stage: test script: - - nox -s coverage -- --run-slow + - nox -s tests -- --run-slow py314: extends: @@ -57,7 +57,15 @@ py314: image: python:3.14 stage: test script: - - nox -s coverage -- --remote-data=any + - nox -s coverage + +py315: + extends: + - .nox + image: python:3.15 + stage: test + script: + - nox -s tests -- --remote-data=any pre: extends: @@ -66,7 +74,7 @@ pre: stage: extra allow_failure: true script: - - PIP_PRE=1 nox -s coverage + - PIP_PRE=1 nox -s tests docs: extends: diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index eaa7db1c..208bdc4c 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -16,12 +16,12 @@ repos: - id: trailing-whitespace - repo: https://github.com/zizmorcore/zizmor-pre-commit - rev: v1.30.1 + rev: v1.31.1 hooks: - id: zizmor - repo: https://github.com/astral-sh/ruff-pre-commit - rev: v0.16.10 + rev: v0.17.1 hooks: - id: ruff-check args: [ --fix, --show-fixes, --exit-non-zero-on-fix ] diff --git a/.readthedocs.yml b/.readthedocs.yml index cc7118ad..5b7b6aa6 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -1,9 +1,9 @@ version: 2 build: - os: ubuntu-24.04 + os: ubuntu-lts-latest tools: - python: "3.13" + python: latest sphinx: configuration: docs/conf.py From 4f141540ddee47a968f59f8b8ba3c19f5d5a88ac Mon Sep 17 00:00:00 2001 From: Simon Conseil Date: Fri, 16 Oct 2026 11:05:07 +0200 Subject: [PATCH 2/5] update install/testing docs --- .readthedocs.yml | 3 +++ README.rst | 2 +- docs/conf.py | 2 +- docs/credits.rst | 4 ++-- docs/installation.rst | 21 ++++++++++++++------- pyproject.toml | 12 +++++++++--- 6 files changed, 30 insertions(+), 14 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index 5b7b6aa6..23cd8312 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -4,6 +4,9 @@ build: os: ubuntu-lts-latest tools: python: latest + jobs: + post_checkout: + - git fetch --unshallow || true sphinx: configuration: docs/conf.py diff --git a/README.rst b/README.rst index 88cc69d6..2cd6b91e 100644 --- a/README.rst +++ b/README.rst @@ -20,7 +20,7 @@ MPDAF, the *MUSE Python Data Analysis Framework*, is an open-source (BSD licensed) Python package, developed and maintained by `CRAL -`_ and partially funded by the ERC advanced grant +`_ and partially funded by the ERC advanced grant 339659-MUSICOS (see `Authors and Credits `_ for more details). It has been developed and used in the `MUSE Consortium diff --git a/docs/conf.py b/docs/conf.py index 88767065..1e971025 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -98,7 +98,7 @@ import matplotlib as mpl import matplotlib.pyplot as plt from mpdaf import setup_logging -if os.path.relpath(os.curdir, start=os.pardir) != 'data': os.chdir('../lib/mpdaf/data') +if os.path.relpath(os.curdir, start=os.pardir) != 'data': os.chdir('../src/mpdaf/data') setup_logging(stream=sys.stdout) """.splitlines() diff --git a/docs/credits.rst b/docs/credits.rst index 54d00c09..695b0039 100644 --- a/docs/credits.rst +++ b/docs/credits.rst @@ -2,8 +2,8 @@ Authors and Credits ******************* -MPDAF team at `CRAL `_ ---------------------------------------------------- +MPDAF team at `CRAL `_ +------------------------------------------------- - Roland Bacon, scientific manager - Johan Richard, scientific adviser diff --git a/docs/installation.rst b/docs/installation.rst index 58b9156b..0bdec557 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -7,11 +7,10 @@ Requirements MPDAF has the following strict requirements: -- Python_ version 2.7 or 3.3+ -- Numpy_ version 1.8 or above -- Scipy_ version 0.14 or above -- Matplotlib_ version 1.4 or above -- Astropy_ version 1.0 or above +- Numpy_ version 2.0 or above +- Scipy_ version 1.13 or above +- Matplotlib_ version 3.9.0 or above +- Astropy_ version 7.0.0 or above Several additional packages can be installed for optional features: @@ -105,12 +104,19 @@ Unit tests To run the unit tests, you need to install the Pytest_ package, then run:: - $ python setup.py test + $ pip install pytest + $ pytest To run the unit tests on an installed version of MPDAF:: - $ pytest $(dirname $(python -c 'import mpdaf; print(mpdaf.__file__)')) + $ pytest --pyargs mpdaf +A more convenient option is to use nox_, which will take care of creating +a virtual environment dedicated to running tests and run pytest:: + + $ pip install nox + $ nox -s tests + $ nox -s coverage .. _Python: http://python.org/ .. _Numpy: http://www.numpy.org/ @@ -127,3 +133,4 @@ To run the unit tests on an installed version of MPDAF:: .. _OpenAstronomy: https://anaconda.org/openastronomy .. _conda: http://conda.pydata.org/docs/ .. _adjustText: https://github.com/Phlya/adjustText +.. _nox: https://nox.thea.codes/ diff --git a/pyproject.toml b/pyproject.toml index 853174b8..5ce02d80 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -28,8 +28,8 @@ classifiers = [ "Topic :: Scientific/Engineering :: Physics" ] dependencies = [ - "astropy", - "matplotlib", + "astropy>7.0.0", + "matplotlib>=3.9.0", "numpy>=2.0", "scipy>=1.13", "specutils>=2.0.0", @@ -48,7 +48,13 @@ docs = [ "sphinx_automodapi", "sphinx_rtd_theme", ] -tests = ["pytest", "pytest-astropy", "pytest-cov", "pytest-remotedata"] +tests = [ + "pytest", + "pytest-cov", + "pytest-doctestplus", + "pytest-remotedata", + "pytest-skip-slow", +] [project.scripts] make_white_image = "mpdaf.scripts.make_white_image:main" From 0ee0dc46f488009f532250e687debda8c0de74e1 Mon Sep 17 00:00:00 2001 From: Simon Conseil Date: Fri, 16 Oct 2026 11:30:44 +0200 Subject: [PATCH 3/5] misc docs update --- docs/Makefile | 229 +++--------------------------------------- docs/conf.py | 157 ++--------------------------- docs/contribute.rst | 21 ++-- docs/installation.rst | 12 +-- 4 files changed, 41 insertions(+), 378 deletions(-) diff --git a/docs/Makefile b/docs/Makefile index 506dfd78..d4bb2cbb 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -1,221 +1,20 @@ -# Makefile for Sphinx documentation +# Minimal makefile for Sphinx documentation # -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -PAPER = -BUILDDIR = build +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = . +BUILDDIR = _build -# User-friendly check for sphinx-build -ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) -$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) -endif - -# Internal variables. -PAPEROPT_a4 = -D latex_paper_size=a4 -PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . -# the i18n builder cannot share the environment and doctrees with the others -I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . - -.PHONY: help +# Put it first so that "make" without argument is like "make help". help: - @echo "Please use \`make ' where is one of" - @echo " html to make standalone HTML files" - @echo " dirhtml to make HTML files named index.html in directories" - @echo " singlehtml to make a single large HTML file" - @echo " pickle to make pickle files" - @echo " json to make JSON files" - @echo " htmlhelp to make HTML files and a HTML help project" - @echo " qthelp to make HTML files and a qthelp project" - @echo " applehelp to make an Apple Help Book" - @echo " devhelp to make HTML files and a Devhelp project" - @echo " epub to make an epub" - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" - @echo " latexpdf to make LaTeX files and run them through pdflatex" - @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" - @echo " text to make text files" - @echo " man to make manual pages" - @echo " texinfo to make Texinfo files" - @echo " info to make Texinfo files and run them through makeinfo" - @echo " gettext to make PO message catalogs" - @echo " changes to make an overview of all changed/added/deprecated items" - @echo " xml to make Docutils-native XML files" - @echo " pseudoxml to make pseudoxml-XML files for display purposes" - @echo " linkcheck to check all external links for integrity" - @echo " doctest to run all doctests embedded in the documentation (if enabled)" - @echo " coverage to run coverage check of the documentation (if enabled)" - -.PHONY: clean -clean: - rm -rf $(BUILDDIR)/* api/* - -.PHONY: html -html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." - -.PHONY: dirhtml -dirhtml: - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." - -.PHONY: singlehtml -singlehtml: - $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml - @echo - @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." - -.PHONY: pickle -pickle: - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle - @echo - @echo "Build finished; now you can process the pickle files." - -.PHONY: json -json: - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json - @echo - @echo "Build finished; now you can process the JSON files." - -.PHONY: htmlhelp -htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp - @echo - @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp." - -.PHONY: qthelp -qthelp: - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp - @echo - @echo "Build finished; now you can run "qcollectiongenerator" with the" \ - ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Test.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Test.qhc" - -.PHONY: applehelp -applehelp: - $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp - @echo - @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." - @echo "N.B. You won't be able to view it unless you put it in" \ - "~/Library/Documentation/Help or install it in your application" \ - "bundle." - -.PHONY: devhelp -devhelp: - $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp - @echo - @echo "Build finished." - @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/Test" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Test" - @echo "# devhelp" - -.PHONY: epub -epub: - $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub - @echo - @echo "Build finished. The epub file is in $(BUILDDIR)/epub." - -.PHONY: latex -latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." - @echo "Run \`make' in that directory to run these through (pdf)latex" \ - "(use \`make latexpdf' here to do that automatically)." - -.PHONY: latexpdf -latexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through pdflatex..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -.PHONY: latexpdfja -latexpdfja: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through platex and dvipdfmx..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -.PHONY: text -text: - $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text - @echo - @echo "Build finished. The text files are in $(BUILDDIR)/text." - -.PHONY: man -man: - $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man - @echo - @echo "Build finished. The manual pages are in $(BUILDDIR)/man." - -.PHONY: texinfo -texinfo: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo - @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." - @echo "Run \`make' in that directory to run these through makeinfo" \ - "(use \`make info' here to do that automatically)." - -.PHONY: info -info: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo "Running Texinfo files through makeinfo..." - make -C $(BUILDDIR)/texinfo info - @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." - -.PHONY: gettext -gettext: - $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale - @echo - @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." - -.PHONY: changes -changes: - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes - @echo - @echo "The overview file is in $(BUILDDIR)/changes." - -.PHONY: linkcheck -linkcheck: - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck - @echo - @echo "Link check complete; look for any errors in the above output " \ - "or in $(BUILDDIR)/linkcheck/output.txt." - -.PHONY: doctest -doctest: - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest - @echo "Testing of doctests in the sources finished, look at the " \ - "results in $(BUILDDIR)/doctest/output.txt." - -.PHONY: coverage -coverage: - $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage - @echo "Testing of coverage in the sources finished, look at the " \ - "results in $(BUILDDIR)/coverage/python.txt." - -.PHONY: xml -xml: - $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml - @echo - @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) -.PHONY: pseudoxml -pseudoxml: - $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml - @echo - @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." - rsync -avh --delete build/html/ urania1:/srv/trac/mpdaf/htdocs/DocCoreLib/ +.PHONY: help Makefile -.PHONY: sync -sync: - rsync -avh --delete build/html/ urania1:/srv/trac/mpdaf/htdocs/DocCoreLib/ +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/conf.py b/docs/conf.py index 1e971025..e3527a9e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,13 +1,15 @@ -# mpdaf documentation build configuration file, created by -# sphinx-quickstart on Fri Jun 22 10:03:09 2012. +# Configuration file for the Sphinx documentation builder. +# +# For the full list of built-in configuration values, see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html import importlib.metadata -import warnings # -- Project information ----------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information project = 'MPDAF' -copyright = '2010-2019, CRAL' +copyright = '2010-2026, CRAL' author = 'MPDAF Team' release = importlib.metadata.version("mpdaf") @@ -15,13 +17,8 @@ version = '.'.join(release.split('.')[:2]) # -- General configuration ---------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration -# If your documentation needs a minimal Sphinx version, state it here. -# needs_sphinx = '1.0' - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.autosummary', @@ -30,27 +27,16 @@ 'sphinx.ext.intersphinx', 'sphinx.ext.mathjax', 'sphinx.ext.viewcode', - 'numpydoc', 'IPython.sphinxext.ipython_console_highlighting', 'IPython.sphinxext.ipython_directive', + 'matplotlib.sphinxext.plot_directive', + 'numpydoc', 'pytest_doctestplus.sphinx.doctestplus', 'sphinx_automodapi.automodapi', 'sphinx_automodapi.smart_resolver', - 'sphinx_rtd_theme' + 'sphinx_rtd_theme', ] -try: - import matplotlib.sphinxext.plot_directive - extensions += [matplotlib.sphinxext.plot_directive.__name__] -# AttributeError is checked here in case matplotlib is installed but -# Sphinx isn't. Note that this module is imported by the config file -# generator, even if we're not building the docs. -except (ImportError, AttributeError): - warnings.warn( - "matplotlib's plot_directive could not be imported. " - "Inline plots will not be included in the output", stacklevel=2 - ) - intersphinx_mapping = { 'python': ('https://docs.python.org/3/', None), 'numpy': ('https://numpy.org/doc/stable/', None), @@ -125,34 +111,6 @@ # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] -# The suffix(es) of source filenames. -# You can specify multiple suffix as a list of string: -# source_suffix = ['.rst', '.md'] -source_suffix = '.rst' - -# The encoding of source files. -# source_encoding = 'utf-8-sig' - -# The master toctree document. -master_doc = 'index' - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. -language = 'en' - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -# today = '' -# Else, today_fmt is used as the format for a strftime call. -# today_fmt = '%B %d, %Y' - # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. exclude_patterns = ['_build', '_templates'] @@ -161,26 +119,9 @@ # documents. Set to the "smart" one. default_role = 'obj' -# If true, '()' will be appended to :func: etc. cross-reference text. -# add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -# add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -# show_authors = False - # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' -# A list of ignored prefixes for module index sorting. -# modindex_common_prefix = [] - -# If true, keep warnings as "system message" paragraphs in the built documents. -# keep_warnings = False - # -- Options for HTML output -------------------------------------------------- html_theme = "sphinx_rtd_theme" @@ -190,22 +131,10 @@ # documentation. # html_theme_options = {} -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -# html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -# html_short_title = None - # The name of an image file (relative to this directory) to place at the top # of the sidebar. html_logo = '_static/logo/logo_mpdaf_small.png' -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -# html_favicon = None - # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". @@ -219,69 +148,3 @@ # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. html_last_updated_fmt = '%d %b %Y' - -# Custom sidebar templates, maps document names to template names. -# html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -# html_additional_pages = {} - -# If false, no module index is generated. -# html_domain_indices = True - -# If true, links to the reST sources are added to the pages. -html_show_sourcelink = False - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -# html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -# html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -html_use_opensearch = 'http://mpdaf.readthedocs.io/en/latest/' - -# Output file base name for HTML help builder. -htmlhelp_basename = 'mpdafdoc' - - -# -- Options for LaTeX output ------------------------------------------------- - -# The paper size ('letter' or 'a4'). -# latex_paper_size = 'letter' - -# The font size ('10pt', '11pt' or '12pt'). -# latex_font_size = '10pt' - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, documentclass [howto/manual]). -latex_documents = [ - ('index', 'mpdaf.tex', 'mpdaf Documentation', - 'LP', 'manual'), -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -# latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -# latex_use_parts = False - -# If true, show page references after internal links. -# latex_show_pagerefs = False - -# If true, show URL addresses after external links. -# latex_show_urls = False - -# Additional stuff for the LaTeX preamble. -# latex_preamble = '' - -# Documents to append as an appendix to all manuals. -# latex_appendices = [] - -# If false, no module index is generated. -# latex_domain_indices = True diff --git a/docs/contribute.rst b/docs/contribute.rst index 72642510..21b118ea 100644 --- a/docs/contribute.rst +++ b/docs/contribute.rst @@ -23,14 +23,14 @@ in your environment:: git clone https://git-cral.univ-lyon1.fr/MUSE/mpdaf.git -There are many options to install, but it is recommended to use a `virtual -environment`_ (virtualenv, or Conda's environments) to avoid conflicts with +There are many options to install, but it is recommended to use a virtual +environment (virtualenv, or Conda's environments) to avoid conflicts with your regular install. Then, you can install MPDAF. Using the development mode makes it easier to test changes, without having to reinstall after each change:: - python setup.py develop + pip install -e . -v Git workflow @@ -72,18 +72,19 @@ To run the tests, you need to install `pytest`_:: And run:: - python setup.py test + pytest -It is also possible to run tests on multiple Python versions with `tox`_:: - - pip install tox +It is also possible to run tests on multiple Python versions with `nox`_:: + pip install nox + nox -s tests + nox -s coverage + nox -s docs .. _build status: https://git-cral.univ-lyon1.fr/MUSE/mpdaf/builds .. _git-cral: https://git-cral.univ-lyon1.fr .. _Merge request: https://git-cral.univ-lyon1.fr/MUSE/mpdaf/merge_requests .. _pytest: https://pytest.org/ -.. _tox: http://tox.readthedocs.io/en/stable/ -.. _virtual environment: http://docs.astropy.org/en/latest/development/workflow/virtual_pythons.html -.. _well-detailed documentation: http://docs.astropy.org/en/latest/development/workflow/development_workflow.html +.. _nox: https://nox.thea.codes/ +.. _well-detailed documentation: https://docs.astropy.org/en/latest/development/quickstart.html diff --git a/docs/installation.rst b/docs/installation.rst index 0bdec557..81370ee3 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -104,19 +104,19 @@ Unit tests To run the unit tests, you need to install the Pytest_ package, then run:: - $ pip install pytest - $ pytest + pip install pytest + pytest To run the unit tests on an installed version of MPDAF:: - $ pytest --pyargs mpdaf + pytest --pyargs mpdaf A more convenient option is to use nox_, which will take care of creating a virtual environment dedicated to running tests and run pytest:: - $ pip install nox - $ nox -s tests - $ nox -s coverage + pip install nox + nox -s tests + nox -s coverage .. _Python: http://python.org/ .. _Numpy: http://www.numpy.org/ From 7b6ca97f2c15b9b292f1e77251cf4bb852e1ce48 Mon Sep 17 00:00:00 2001 From: Simon Conseil Date: Fri, 16 Oct 2026 14:44:48 +0200 Subject: [PATCH 4/5] update changelog --- CHANGELOG | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CHANGELOG b/CHANGELOG index bf08da43..83a40bea 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,9 +1,9 @@ 3.7dev ------ -- Use fork by default for `loop_*_multiprocessing`. +- Compatibility fixes for recent versions of Python, Numpy and specutils. -- Compatibility fixes for recent Numpy and specutils. +- Use fork by default for `loop_*_multiprocessing`. - Fix logger issue in `Image.subimage`. From 51acd2fc53d89584be631af9166888c43b005960 Mon Sep 17 00:00:00 2001 From: Simon Conseil Date: Fri, 16 Oct 2026 15:11:41 +0200 Subject: [PATCH 5/5] cfitsio --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 5ce02d80..5f432ea1 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -157,5 +157,5 @@ test-command = "pytest {project}/src" test-extras = ["tests"] [tool.cibuildwheel.linux] -before-all = ["yum install cfitsio -y"] +before-all = ["yum install cfitsio-devel -y"] environment.USEOPENMP = 0