sphinxcontrib-chapeldomain 0.0.36

Chapel domain for Sphinx

Chapel domain for Sphinx.

Package documentation is available on readthedocs.org.

Installation

To install:

python3 -m pip install sphinxcontrib-chapeldomain

To install from source on github:

git clone https://github.com/chapel-lang/sphinxcontrib-chapeldomain
cd sphinxcontrib-chapeldomain
python setup.py install

Getting Started

This is an example that covers several features of the Chapel domain:

.. chpl:module:: GMP
    :synopsis: multiple precision integer library

.. chpl:record:: BigNum

    multiple precision instances

    .. chpl:method:: proc add(a:BigNum, b:BigNum)

        Add two big ints, ``a`` and ``b``, and store the result in ``this``
        instance.

        :arg a: BigNum to be added
        :type a: BigNum

        :arg BigNum b: BigNum to be added

        :returns: nothing, result is stored in current instance

    .. chpl:itermethod:: iter these() ref

        Arbitrary iterator that returns individual digits of this instance.

        :ytype: reference
        :yields: reference to each individual digit of BigNum