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: Wed May 31 09:28:06 2023 UTC

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

  Python 3.8.6 (default, May 10 2023, 17:44:10)  [GCC 7.5.0]

             sphinx : 6.2.1
           numpydoc : 1.5.0
      sphinx_design : 0.4.1
      sphinx_numfig : 0.1.0
     sphinx_gallery : 0.13.0
    memory_profiler : 0.61.0
pydata_sphinx_theme : 0.13.3
  sphinx_automodapi : 0.15.0
          ipykernel : 6.23.1
              numpy : 1.24.3
              scipy : 1.10.1
              numba : 0.57.0
            empymod : 2.2.2
            IPython : 8.12.2
         matplotlib : 3.7.1
--------------------------------------------------------------------------------