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

support for deprecation directive #71

Closed
1ucian0 opened this issue Aug 28, 2022 · 1 comment · Fixed by #73
Closed

support for deprecation directive #71

1ucian0 opened this issue Aug 28, 2022 · 1 comment · Fixed by #73
Labels
help wanted Extra attention is needed

Comments

@1ucian0
Copy link
Member

1ucian0 commented Aug 28, 2022

In Qiskit/qiskit#8600 (comment), @jakelishman suggested to use the deprecated directive in the docstrings to announce deprecations. However, the theme does not have support for it.

The following rst

.. WARNING:: Strong prose may provoke extreme mental exertion.
   Reader discretion is strongly advised.

.. deprecated:: 1.2.3
   Deprecation

is rendered as
Screenshot 2022-08-28 at 11 20 08
@1ucian0 1ucian0 mentioned this issue Aug 28, 2022
Closed
@1ucian0 1ucian0 added the help wanted Extra attention is needed label Aug 28, 2022
@1ucian0
Copy link
Member Author

1ucian0 commented Aug 28, 2022

This issue is blocking Qiskit/qiskit#8600

@1ucian0 1ucian0 mentioned this issue Aug 31, 2022
Merged
@HuangJunye HuangJunye moved this to Backlog in Qiskit Sphinx Theme Sep 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
help wanted Extra attention is needed
Projects
No open projects
Qiskit Sphinx Theme
Status: Backlog
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Deprecation note support 1ucian0/qiskit_sphinx_theme
1 participant
@1ucian0