[JOSS] Cross-reference functions in documentation

[blsqr]

First off: what I've read of the documentation so far is very nicely written 👍

I think what would further improve it would be cross-references to the API documentation. For instance, in working.rst, a link to init_simple would be very useful, I think, as it allows to check out the function signature and other available arguments.

You already have the API reference as part of your documentation via automodule, if I see it correctly. To reference to it, you can use the domain syntax. For instance, :py:func: can be used to reference a function:

The initial conditions are instantiated using the function
:py:func:`~cellpylib.ca_functions.init_simple`, which, in this example ...

which yields a link to the API docs when rendered:

I would propose to do this across all of the docs, as it really reduces friction, makes the functions stand out more, and makes the docs overall more useful. I think this could be applied semi-automatically across many files of the docs using search-and-replace, such that workload does not go over the top?

[blsqr]

Also, I would propose to consistently use the verbatim sphinx markup (double-backticks) when referring to function arguments, e.g.:

Any function that accepts the three arguments ``n``, ``c`` and ``t``
can be supplied as a rule, but in this case the built-in function
:py:func:`~cellpylib.ca_functions.nks_rule` is invoked to provide Rule 30.

[lantunes]

Thanks for pointing this out. I have updated the docs accordingly. The changes are on the joss_review branch.