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(
   ...:     ['sphinx', 'numpydoc', 'sphinx_design', 'sphinx_numfig',
   ...:      'sphinx_gallery', 'memory_profiler', 'pydata_sphinx_theme',
   ...:      'sphinx_automodapi', 'ipykernel', ]
   ...: )
   ...: 
Out[1]: 

--------------------------------------------------------------------------------
  Date: Tue Jun 25 14:48:15 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]

             sphinx : 7.3.7
           numpydoc : 1.7.0
      sphinx_design : 0.6.0
      sphinx_numfig : 0.1.1
     sphinx_gallery : 0.16.0
    memory_profiler : 0.61.0
pydata_sphinx_theme : 0.15.3
  sphinx_automodapi : 0.17.0
          ipykernel : 6.29.4
              numpy : 1.26.4
              scipy : 1.14.0
              numba : 0.60.0
            empymod : 2.3.1
             libdlf : 0.2.0
            IPython : 8.25.0
         matplotlib : 3.9.0
--------------------------------------------------------------------------------