sphinxcontrib-chapeldomain

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

Making Changes

Test and commit changes
Merge your changes
Generate a new PyPI release

Making a Release

Go to main page for repo
Click “Releases” on right side of screen
Click “Draft a new release” button on top of screen
For the tag, make a new tag with the new version number
You can generate the release notes via the “generate release notes” button, comparing against the most recent release. This will autofill in the details for you
Click “Publish release”
- This will trigger the workflow to push a new release to PyPI, assuming no problems have snuck into our release procedure since the last time it was run
Open a PR bumping the version to the next version number so that we’re ready for the next change. This should always be the first PR in a new release (otherwise we’ll have build issues). This can be done by running the ‘bump-version’ GitHub Action, which will create the PR for you.

In case of issues, the release pushing job is in .github/workflows/python-publish.yml

You can modify it to try and get things to work. If the issue has something to do with what was pushed to PyPI, you can adjust it to send to https://test.pypi.org/ instead and download from there. You’ll want to remove the bad version from PyPI in that case, which will require access to a user account associated with the repository on PyPI.

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

Metadata

Release files for sphinxcontrib-chapeldomain 0.0.41

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sphinxcontrib-chapeldomain 0.0.41
File	Size	Uploaded
sphinxcontrib_chapeldomain-0.0.41.tar.gz	31.7 kB	Mar 30, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for sphinxcontrib-chapeldomain 0.0.41
File	Interpreter	ABI	Platform	Reset
sphinxcontrib_chapeldomain-0.0.41-py3-none-any.whl 23.3 kB Mar 30, 2026	Python 3	none	any	Details

Total release size: 54.9 kB

Release files / sphinxcontrib_chapeldomain-0.0.41.tar.gz

Download URL	sphinxcontrib_chapeldomain-0.0.41.tar.gz
Size	31.7 kB
Tags	Source
SHA-256 checksum How to use checksums	`07b71391e28664e5ed47aef25d7852e3d15a311d1c4cd63e971e493e379e47c2`
BLAKE2b-256 checksum How to use checksums	`a2514fffb0a5313c1059bc18126fcb1981bd7100aaf7763bf3019da6bf4ba718`
Upload date	Mar 30, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.13.7`

Release files / sphinxcontrib_chapeldomain-0.0.41-py3-none-any.whl

Download URL	sphinxcontrib_chapeldomain-0.0.41-py3-none-any.whl
Size	23.3 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`a30c436ea4513f4ef1252a923cf5d565e6612f4e5f8fcff72aa8887351d1bb19`
BLAKE2b-256 checksum How to use checksums	`c8af9ea5e9b322bad99e9a59b32d7e089c754e1c189961033f586a0440ca0f32`
Upload date	Mar 30, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.13.7`