PlasmaCalcs
Usage
PlasmaCalcs API
plasma_calculator
quantities
dimensions
units
hookups
addons
other_calculators
mhd
multi_run_analysis
tools
array_select
arrays
display
docs_tools
_optdoc
docstring_but_strip_examples
format_docstring
list_objs
sphinx_docstring
DocstringInfo
fft_tools
history
imports
io_tools
iterables
math
multiprocessing
oop_tools
os_tools
properties
pytools
sci_tools
sentinels
sql_tools
supercomputer
timing
trees
xarray_tools
plotting
defaults
errors
PlasmaCalcs
PlasmaCalcs API
tools
docs_tools
sphinx_docstring
View page source
sphinx_docstring
PlasmaCalcs.tools.docs_tools.
sphinx_docstring
(
f
)
return sphinx docstring for this object.
None if f.__doc__ is None or doesn’t exist.
Else, DocstringInfo(f.__doc__).to_sphinx()