11668770899
100%

Ran 04 Nov 2024 04:48PM UTC

Jobs 1

Files 32

Run time 1min

Badge

Embed ▾

Committed 04 Nov 2024 04:46PM UTC coverage: 100.0%. Remained the same

Build # 11668770899

Build Type

push

github

Committed by

web-flow

Commit Message

Show class members (#702)

We weren't showing class members (attributes & methods) for inlined classes. This is fixed by setting `"inherited-members": None` in `autodoc_default_options`. 

Notably, we now show inherited members for classes like `instructions.Move`. I recommend this because users want to know every function/attribute defined on the object, and they don't really care about the origin of that functionality. Qiskit SDK takes this approach, which is useful with e.g. the circuit library.

With this change, some of the classes end up being much larger. So, we un-inline them and move them back to being their own pages in `stubs/`. This means we remove their client redirects.

This PR also makes some other enhancements:

* Adds `tox -e docs-clean`
* Displays type hints in the `parameters` section, rather than inline to the signature. This matches the style of the other API projects

Run Details

2330 of 2330 relevant lines covered (100.0%)

1.0 hits per line

Jobs

ID	Job ID	Ran	Files	Coverage
1	11668770899.1	04 Nov 2024 04:48PM UTC	32	100.0	GitHub Action Run

Qiskit / qiskit-addon-cutting / 11668770899
100%

README BADGES
x

Markdown

Textile

RDoc

HTML

Rst

Jobs

Source Files on build 11668770899

Qiskit / qiskit-addon-cutting / 11668770899 100%

README BADGES x

Markdown

Textile

RDoc

HTML

Rst

Jobs

Source Files on build 11668770899

Qiskit / qiskit-addon-cutting / 11668770899
100%

README BADGES
x