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

#120: API-containers-DualView from md to rst #285

Merged
merged 10 commits into from
Mar 8, 2023

Conversation

antoinemeyer5
Copy link
Collaborator

@antoinemeyer5 antoinemeyer5 commented Jan 28, 2023

THIS PR:

  • API/containers/DualView transition from .md to .rst
before (.md) after (.rst)
image image
image image
image image
image image
image image

Copy link
Collaborator

@fnrizzi fnrizzi left a comment

Choose a reason for hiding this comment

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

this needs to be converted to sphinx , drop the synopsis please. use all comments as descriptions of sphinx functions. etc

@antoinemeyer5 antoinemeyer5 marked this pull request as draft February 1, 2023 12:09
@antoinemeyer5 antoinemeyer5 requested a review from fnrizzi February 1, 2023 12:32
@antoinemeyer5

This comment was marked as outdated.

@antoinemeyer5 antoinemeyer5 marked this pull request as ready for review February 4, 2023 17:00
@fnrizzi fnrizzi marked this pull request as draft February 7, 2023 10:28
@antoinemeyer5 antoinemeyer5 marked this pull request as ready for review February 7, 2023 16:13
@fnrizzi fnrizzi force-pushed the 120-API-containers-DualView branch from fa8fffa to a75aa82 Compare March 7, 2023 07:52
Copy link
Contributor

@tcclevenger tcclevenger left a comment

Choose a reason for hiding this comment

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

Is the alignment of code blocks in our control? For example, in the class description
Old:
Screenshot 2023-03-08 at 11 01 56 AM
New:
Screenshot 2023-03-08 at 11 01 28 AM
The old looks nicer in my opinion, whereas the new is less neat with the = void> hanging and the class DualView indented.

Just curious, wording is fine so I'll approve.

@fnrizzi
Copy link
Collaborator

fnrizzi commented Mar 8, 2023

Is the alignment of code blocks in our control? For example, in the class description Old: Screenshot 2023-03-08 at 11 01 56 AM New: Screenshot 2023-03-08 at 11 01 28 AM The old looks nicer in my opinion, whereas the new is less neat with the = void> hanging and the class DualView indented.

Just curious, wording is fine so I'll approve.

yes, I like the old alignment too. Unfortuantely we cannot control that, or at least not yet. We either have to go and customize things inside our _ext directory for the sphinx stuff, or we have to open an issue with sphinx and ask if there a way they can add that directly in their main sphinx code. I will google a bit to see if I can find something. It was just not a super priority but if you open an issue I can keep it in mind :)

@fnrizzi
Copy link
Collaborator

fnrizzi commented Mar 8, 2023

@tcclevenger found it: sphinx-doc/sphinx#11011
but it is literally in progress so we have to wait !

@fnrizzi fnrizzi merged commit fd4b815 into kokkos:main Mar 8, 2023
@fnrizzi fnrizzi mentioned this pull request Mar 8, 2023
@antoinemeyer5 antoinemeyer5 deleted the 120-API-containers-DualView branch June 14, 2023 12:22
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