How to document a module constant in Python?

Question

I have a module, errors.py in which several global constants are defined (note: I understand that Python doesn\'t have constants, but I\'ve defined them by conv

Answer 1

the following worked for me with Sphinx 2.4.4:

in foo.py :

API_ERROR = 1
"""int: Indicates some unknown error."""

then to document it:

.. automodule:: foo.py 
    :members:

Answer 2

This is an older question, but I noted that a relevant answer was missing.

Or you can just include a description of the constants in the docstring of the module via .. py:data::. That way the documentation is also made available via the interactive help. Sphinx will render this nicely.

"""
Docstring for my module.

.. data:: API_ERROR

    Indicates some unknown error.

.. data:: BAD_REQUEST

    Indicates that the request was bad in some way.

.. data:: MISSING_PARAMS

    Indicates that the request is missing required parameters.
"""