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 emg3d
...: emg3d.Report(
...: ['sphinx', 'numpydoc', 'ipykernel', 'sphinx_numfig',
...: 'sphinx_panels', 'sphinx_automodapi', 'pydata_sphinx_theme']
...: )
...:
Out[1]:
--------------------------------------------------------------------------------
Date: Fri May 28 20:48:21 2021 UTC
OS : Linux
CPU(s) : 2
Machine : x86_64
Architecture : 64bit
Environment : IPython
Python 3.8.6 (default, Oct 19 2020, 15:10:29) [GCC 7.5.0]
sphinx : 3.5.4
numpydoc : 1.1.0
ipykernel : 5.5.5
sphinx_numfig : 0.1.0
sphinx_panels : 0.5.2
sphinx_automodapi : 0.13
pydata_sphinx_theme : 0.6.3
numpy : 1.20.3
scipy : 1.6.3
numba : 0.53.1
emg3d : 1.0.0
empymod : 2.0.6
xarray : 0.18.2
discretize : 0.7.0
h5py : 3.2.1
matplotlib : 3.4.2
tqdm : 4.61.0
IPython : 7.24.0
--------------------------------------------------------------------------------