Skip to content

BUG - Github CI doc generation is not working with python 3.11 #271

@sdhoyt

Description

@sdhoyt

Description of the issue

When using python 3.11 in the CI doc.yml, sphinx does not pull from python's documentation. For example, a class with the super class IntEnum is causing an error in sphinx:

/opt/hostedtoolcache/Python/3.11.6/x64/lib/python3.11/site-packages/imap_processing/hit/l0/hit_l1a_decom.py:docstring of imap_processing.hit.l0.hit_l1a_decom.HitAPID:42:<autosummary>:1: WARNING: py:obj reference target not found: imap_processing.hit.l0.hit_l1a_decom.HitAPID.bit_count

because it cannot find a target for built-in python functions in the Subclass

This issue seems specific to the super class IntEnum. If using Enum instead the docs will build.

May be related to this issue:
sphinx-doc/sphinx#10410

Steps to reproduce the issue

Run doc gen using commit #dd9464c

Code Snippet:

- name: Set up Python
      uses: actions/setup-python@v4
      with:
        python-version: '3.11'

Expected behavior (What should happen)

Docs should generate

Actual behavior (What does happen)

/opt/hostedtoolcache/Python/3.11.6/x64/lib/python3.11/site-packages/imap_processing/hit/l0/hit_l1a_decom.py:docstring of imap_processing.hit.l0.hit_l1a_decom.HitAPID:42:<autosummary>:1: WARNING: py:obj reference target not found: imap_processing.hit.l0.hit_l1a_decom.HitAPID.bit_count

Additional notes

No response

Affected areas (code, data, or process)

No response

Suggested fix?

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    Status

    Done

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions