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

Documentation fixes and formatting #1095

Merged
merged 24 commits into from
Mar 22, 2023

Conversation

coruscating
Copy link
Collaborator

@coruscating coruscating commented Mar 20, 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 Pin sphinx-autodoc-typehints version #1017 has been removed. This closes Fix docs incompatibility with sphinx-autodoc-typehints #1018.
  • Updates curve analysis tutorial to the newest version (Refactored docs #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

coruscating and others added 17 commits March 14, 2023 18:10
also fixed broken links and bumped some package versions
renamed env to `docs-lint`, changed arxiv link to abstract instead of
pdf, and various other fixes
linux build is failing on the minimal conf so I'm adding more lines back
in. hard to debug locally because the mac build has a different set of
warnings.
this syncs up the names on the manuals page and the API experiments
page
Removed FakeService and FakeJob since they're more for internal testing
and not useful for most users
@coruscating coruscating requested a review from wshanks March 20, 2023 04:58
Copy link
Collaborator

@wshanks wshanks left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

docs/GUIDELINES.md Outdated Show resolved Hide resolved
docs/tutorials/visualization.rst Show resolved Hide resolved
@@ -143,5 +156,14 @@
BlochTrajectoryAnalysis,
)

from .data_processing import (
Copy link
Collaborator

@wshanks wshanks Mar 20, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Were these all added because they are referenced in the documentation? @nkanazawa1989 is it okay to promote these all to curve_analysis?

Copy link
Collaborator Author

@coruscating coruscating Mar 20, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In particular it's mean_xy_data that's referenced in the average_method analysis option, the others may not be referenced. We should also consider renaming curve_analysis/data_processing.py to avoid name confusion with the data processor module.

Copy link
Collaborator

@wshanks wshanks Mar 20, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I am not sure I fully understand what needs to be curve_analysis/data_processing.py versus qiskit_experiments.data_processing 🙂 It seems like only multi_mean_xy_data, filter_data, and data_sort are imported out of data_processing.py, so I wonder if we want all of these functions to be public, though we need to if we are referring to the docstring (maybe the discussion should be moved).

Copy link
Collaborator

@wshanks wshanks left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!

I am still not sure all those curve_analysis functions need to be documented for outside use, but I don't feel strongly.

@coruscating coruscating added this pull request to the merge queue Mar 22, 2023
@coruscating coruscating merged commit eca6ce2 into qiskit-community:main Mar 22, 2023
@coruscating coruscating deleted the doc-fixes branch March 22, 2023 13:00
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.

Fix docs incompatibility with sphinx-autodoc-typehints
2 participants