CsatiZoltan / CristalX

Identification and analysis of polycrystalline microstructures
https://cristalx.readthedocs.io
GNU Lesser General Public License v3.0
6 stars 7 forks source link

Cross-referencing function names in docstrings #18

Open CsatiZoltan opened 4 years ago

CsatiZoltan commented 4 years ago

When referring to other functions in the docstrings, use (see here)

:py:func:`function_name`

so that the generated Sphinx documentation turn them into links.

CsatiZoltan commented 4 years ago

The recently written documentation follows this, but the previously written references need to be checked.