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

Remove user_v2 from the documentation #1162

Merged
merged 3 commits into from
Oct 13, 2023
Merged

Remove user_v2 from the documentation #1162

merged 3 commits into from
Oct 13, 2023

Conversation

rosesyrett
Copy link
Contributor

@rosesyrett rosesyrett commented Oct 5, 2023

Now that ophyd.v2 has been ported over to ophyd_async, to prevent confusing users we should remove the ophyd user_v2 documentation.

ophyd-async has github pages running, and the bluesky.project.io repo already makes reference to it in the homepage and dropdown. the docs are identical, except for a few objects which are no longer references as they are stored in (the python equivalent of) private modules, which I've spoken to @coretl about, and which he seems to approve of.

@rosesyrett
Copy link
Contributor Author

Currently, the docs job will fail. This is because of the following warning:

/home/rose/Documents/projects/ophyd/ophyd/pv_positioner.py:docstring of ophyd.pv_positioner.PVPositionerComparator:12: WARNING: 'any' reference target not found: done

I'm not sure why this is happening and am investigating.

docs/index.rst Outdated Show resolved Hide resolved
docs/index.rst Show resolved Hide resolved
@rosesyrett
Copy link
Contributor Author

tests are failing because of this issue: #1163

Copy link
Member

@mrakitin mrakitin 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!

@coretl coretl merged commit 61af375 into master Oct 13, 2023
@coretl coretl deleted the remove-v2-docs branch October 13, 2023 10:43
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.

3 participants