Metadata-Version: 2.1
Name: sphinxcontrib-chapeldomain
Version: 0.0.22
Summary: Chapel domain for Sphinx
Home-page: https://github.com/chapel-lang/sphinxcontrib-chapeldomain
Author: Chapel Team
Author-email: chapel+developers@discoursemail.com
License: Apache License v2.0
Download-URL: https://pypi.python.org/pypi/sphinxcontrib-chapeldomain
Platform: any
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Framework :: Sphinx :: Extension
Classifier: Topic :: Documentation
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Text Processing
Classifier: Topic :: Utilities
License-File: LICENSE

Chapel Domain for Sphinx
========================

Chapel_ domain for Sphinx_.

.. _Chapel: http://chapel-lang.org/
.. _Sphinx: http://sphinx-doc.org/

.. image:: https://github.com/chapel-lang/sphinxcontrib-chapeldomain/actions/workflows/CI.yml/badge.svg
    :target: https://github.com/chapel-lang/sphinxcontrib-chapeldomain/actions/workflows/CI.yml

.. image:: https://codecov.io/gh/chapel-lang/sphinxcontrib-chapeldomain/branch/main/graph/badge.svg
    :target: https://codecov.io/gh/chapel-lang/sphinxcontrib-chapeldomain

`Package documentation`_ is available on readthedocs.org.

.. _Package documentation: //sphinxcontrib-chapeldomain.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

.. _github: https://github.com/chapel-lang/sphinxcontrib-chapeldomain

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


