Maintenance#

Status reports and other tools to have the checks all in one place, for quick QC.

Quick overview / QC#

All possible badges of the CI chain. Definitely check this before making a release.

  • GitHub Actions linux GitHub Actions macos & windows GitHub Actions linkcheck Documentation Status

    Ensure CI and docs are passing.

  • PyPI conda-forge

    Ensure latest version is deployed on PyPI and conda.

  • Coveralls Codacy

    Check CI coverage and code quality is good.

  • Airspeed Velocity

    Check Benchmarks are run up to the latest version.

  • Zenodo DOI

    Check Zenodo is linking to the latest release.

Info from ReadTheDocs#

To check the environment in which the documentation was built.

In [1]: import empymod
   ...: empymod.Report([
   ...:     "ipympl",
   ...:     "sphinx",
   ...:     "numpydoc",
   ...:     "ipykernel",
   ...:     "pickleshare",
   ...:     "sphinx_design",
   ...:     "sphinx_numfig",
   ...:     "sphinx_gallery",
   ...:     "memory_profiler",
   ...:     "sphinx_automodapi",
   ...:     "pydata_sphinx_theme",
   ...: ])
   ...: 
Out[1]: 

--------------------------------------------------------------------------------
  Date: Wed Mar 12 21:12:30 2025 UTC

                 OS : Linux (Ubuntu 22.04)
             CPU(s) : 2
            Machine : x86_64
       Architecture : 64bit
                RAM : 7.6 GiB
        Environment : IPython
        File system : ext4

  Python 3.11.10 (main, Nov  5 2024, 16:13:19) [GCC 11.4.0]

             ipympl : 0.9.7
             sphinx : 8.2.3
           numpydoc : 1.8.0
          ipykernel : 6.29.5
        pickleshare : 0.7.5
      sphinx_design : 0.6.1
      sphinx_numfig : 0.1.1
     sphinx_gallery : 0.19.0
    memory_profiler : 0.61.0
  sphinx_automodapi : 0.18.0
pydata_sphinx_theme : 0.16.1
              numpy : 2.1.3
              scipy : 1.15.2
              numba : 0.61.0
            empymod : 2.5.1
             libdlf : 0.3.0
            IPython : 9.0.2
         matplotlib : 3.10.1
--------------------------------------------------------------------------------