Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pin sphinx-autodoc-typehints version #1017

Merged

Conversation

coruscating
Copy link
Collaborator

@coruscating coruscating commented Jan 18, 2023

A temporary version pin like Qiskit/qiskit#9377 to get docs CI working again.

@coruscating
Copy link
Collaborator Author

coruscating commented Jan 18, 2023

The upgraded package version with this fix is working for terra but not experiments, so whatever is causing problems in sphinx-autodoc-typehints 1.21 needs to be investigated further.

@coruscating coruscating merged commit 7e1e2d4 into qiskit-community:main Jan 18, 2023
@coruscating coruscating deleted the pin-autodoc-typehints-version branch January 18, 2023 20:11
coruscating added a commit that referenced this pull request Mar 22, 2023
### Summary

This PR is essentially the documentation fixes from #1080 since the lint
CI pipeline needs more work.

### Details and comments

- The docs are no longer incompatible with the newest
sphinx-autodoc-typehints so the version pin from #1017 has been removed.
This closes #1018.
- Updates curve analysis tutorial to the newest version (#983 had
accidentally reverted to an older version)
- Changes arxiv autolinks from pdfs to abstract page to be more user
friendly
- Renames the new ExperimentData how-to to rerunning analysis and adds
additional info on using `add_data`
- Moved functions from `curve_analysis/data_processing.py` to `utils.py`
- Changes benchmarking experiments to verification experiments on the
manual page to match the library API page
- Added referenced classes and functions that weren't included in the
docs
- Various formatting fixes for passing Sphinx nitpick mode
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants