[Joss review] Building the docs

[AKuederle]

There are a couple of issues with the docs:

Dependencie doumentation:

• numpydoc is required, but not documented in the README
• matplotlib is required, but not documented (btw. matplotlib is also required for the examples, but is not documented there as well)

After trying a couple of things, I was still not able to build the docs or run the doctests. In a clean conda env (Py 3.8) the autodoc-process-signature extension threw a number of errors:

...
WARNING: error while formatting signature for seg1d.algorithm.get_peaks: Handler <function process_numba_docstring at 0x7febb2fbcca0> for event 'autodoc-process-signature' threw an exception
WARNING: error while formatting signature for seg1d.algorithm.resample: Handler <function process_numba_docstring at 0x7febb2fbcca0> for event 'autodoc-process-signature' threw an exception
WARNING: error while formatting signature for seg1d.algorithm.rolling_corr: Handler <function process_numba_docstring at 0x7febb2fbcca0> for event 'autodoc-process-signature' threw an exception
WARNING: error while formatting signature for seg1d.algorithm.uniques: Handler <function process_numba_docstring at 0x7febb2fbcca0> for event 'autodoc-process-signature' threw an exception
WARNING: error while formatting signature for seg1d.optimized_funcs.rcor: Handler <function process_numba_docstring at 0x7febb2fbcca0> for event 'autodoc-process-signature' threw an exception
WARNING: error while formatting signature for seg1d.optimized_funcs.vcor: Handler <function process_numba_docstring at 0x7febb2fbcca0> for event 'autodoc-process-signature' threw an exception

Extension error:
Handler <function process_numba_docstring at 0x7febb2fbcca0> for event 'autodoc-process-signature' threw an exception

[cadop]

Sorry about that. Something seems to have changed in one of the packages.

Readme is updated 86a19424b58b0bd99360283795fcab98070e031b

Documentation is updated a85ebdafb91767c2facf9532a338cc9ff99b8cee

Fixed conf.py 4f191783a2f7e5f3d279b43d9008820c46f789e4

[cadop]

@AKuederle is this resolved on your end?

[AKuederle]

Yes :)