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

Fix method theme #146

Merged
merged 4 commits into from
Jan 10, 2023
Merged

Conversation

karlaspuldaro
Copy link
Contributor

@karlaspuldaro karlaspuldaro commented Dec 12, 2022

Fixes #45

This PR fixes the methods level rendering to match functions style.

  • CSS selector was not picking up correct element with targeted method class. (this was one problem but it did not fully match functions theme style)
  • Adjusts all elements style under method and static method html class to be consistent with functions styling theme
    image
    Compared to functions theme rendering:
    image

Follow up on separate PR:

  • Add a methods.rst example under docs/sphinx-guide/

@CLAassistant
Copy link

CLAassistant commented Dec 12, 2022

CLA assistant check
All committers have signed the CLA.

@karlaspuldaro
Copy link
Contributor Author

@1ucian0 @javabster This PR is ready for review/comments :)

@HuangJunye HuangJunye self-assigned this Dec 16, 2022
@HuangJunye
Copy link
Contributor

@karlaspuldaro Thanks for your contribution! This looks great! I will review your PR soon.

@HuangJunye HuangJunye assigned javabster and unassigned HuangJunye Jan 3, 2023
@javabster
Copy link
Collaborator

This looks great to me, thanks so much @karlaspuldaro!

To answer your questions:

  • yes I think it would be great to include the staticmethod html class with these changes too
  • a methods.rst example would be helpful in the docs guidelines, but you can add that in a new PR as it is slightly out of scope and not blocking for this work

@karlaspuldaro
Copy link
Contributor Author

karlaspuldaro commented Jan 9, 2023

@javabster Thank you for reviewing! I believe all comments have been addressed, and I've created a new issue to track the follow up idea of adding method.rst to docs guide.

Copy link
Collaborator

@javabster javabster left a comment

Choose a reason for hiding this comment

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

LGTM thanks @karlaspuldaro 🚀

@javabster javabster merged commit c3b0e61 into Qiskit:main Jan 10, 2023
@karlaspuldaro karlaspuldaro deleted the fix-methods-rendering branch January 10, 2023 17:18
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.

API doc "methods" level docstring keywords are not rendered with special headings
4 participants