Skip to content

with_credentials docstring breaks docs builds #650

@Andy-Grigg

Description

@Andy-Grigg

🔍 Before submitting the issue

  • I have searched among the existing issues
  • I am using a Python virtual environment

🐞 Description of the bug

As a result of the recent 2.1 release, the docs build process for PyGranta packages is broken. See ansys/grantami-recordlists#311 for an example. Two sub-issues here:

Broken reference

The major CI-blocking issue is caused because we pull in the method docstring when we inherit the class, which then refers to the enum class which doesn't exist. A possible workaround here is to import the enum into RecordLists and document it there.

Versionadded directive

There is another related issue though, in that we added .. versionadded:: directives to the new enum and method parameter as well. These remain and refer to the wrong version. This could be avoided by making it clear in the versionadded text that this refers to the version of ansys.openapi.common, not the version of the inheriting package. Maybe with an intersphix-derived link to the docs of the class in question.

📝 Steps to reproduce

See ansys/grantami-recordlists#311 CI

💻 Which operating system are you using?

Windows

📀 Which ANSYS version are you using?

N/AS

🐍 Which Python version are you using?

3.9

📦 Installed packages

See https://github.com/ansys/grantami-recordlists/pull/311

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions