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.

Ensure CI and docs are passing.
Ensure latest version is deployed on PyPI and conda.
Check CI coverage and code quality is good.
Check Benchmarks are run up to the latest version.
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 Oct 16 19:45:21 2024 UTC

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

  Python 3.11.9 (main, Jun 18 2024, 09:40:25) [GCC 11.4.0]

             ipympl : 0.9.4
             sphinx : 8.1.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.18.0
    memory_profiler : 0.61.0
  sphinx_automodapi : 0.18.0
pydata_sphinx_theme : 0.15.4
              numpy : 2.0.2
              scipy : 1.14.1
              numba : 0.60.0
            empymod : 2.3.3
             libdlf : 0.2.0
            IPython : 8.28.0
         matplotlib : 3.9.2
--------------------------------------------------------------------------------