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.

Sign up for GitHub

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

Jump to bottom

Fix docs incompatibility with sphinx-autodoc-typehints #1018

Closed
coruscating opened this issue Jan 18, 2023 · 0 comments · Fixed by #1095 · May be fixed by #1080
Closed

Fix docs incompatibility with sphinx-autodoc-typehints #1018

coruscating opened this issue Jan 18, 2023 · 0 comments · Fixed by #1095 · May be fixed by #1080
Labels
bug Something isn't working

Comments

@coruscating
Copy link
Collaborator

The CI tests are failing with sphinx-autodoc-typehints 1.21.0 and above with this build error:

Extension error (sphinx_autodoc_typehints):
Handler <function process_docstring at 0x7febbe52b9d0> for event 'autodoc-process-docstring' threw an exception (exception: )

A temporary version pin #1017 has been put in, but we need to figure out a solution for the newer versions.
@coruscating coruscating added the bug Something isn't working label Jan 18, 2023
This was referenced Mar 14, 2023
Draft
Merged
coruscating added a commit that referenced this issue Mar 22, 2023
@coruscating
Documentation fixes and formatting (#1095)
eca6ce2 
### 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
Assignees
No one assigned
Labels
bug Something isn't working
Projects
None yet
Milestone
No milestone
1 participant
@coruscating