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

Improve docs #195

Merged
merged 5 commits into from
Nov 15, 2024
Merged

Improve docs #195

merged 5 commits into from
Nov 15, 2024

Conversation

yasahi-hpc
Copy link
Collaborator

@yasahi-hpc yasahi-hpc commented Nov 5, 2024

This PR aims at improving the documentation.

  • Improve the using section
  • Rename librarie name as kokkos-fft
  • Fix Kokkos minimal version to Kokkos 4.4+
  • Link to the inplace transform example
  • Fix docstrings for some FFT APIs
  • Fix broken docstrings for some helper APIs (Pass views by const& in fftshift #192)

@yasahi-hpc yasahi-hpc self-assigned this Nov 5, 2024
@yasahi-hpc yasahi-hpc added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 5, 2024
tpadioleau
tpadioleau previously approved these changes Nov 15, 2024
Copy link
Member

@tpadioleau tpadioleau left a comment

Choose a reason for hiding this comment

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

Ok for me

docs/intro/using.rst Outdated Show resolved Hide resolved
docs/examples.rst Outdated Show resolved Hide resolved
@yasahi-hpc
Copy link
Collaborator Author

Thanks!
Do we need a new line at eof for rst files?

@yasahi-hpc yasahi-hpc merged commit bbf765a into kokkos:main Nov 15, 2024
20 checks passed
@yasahi-hpc yasahi-hpc deleted the improve-docs branch November 15, 2024 19:07
yasahi-hpc added a commit to yasahi-hpc/kokkos-fft that referenced this pull request Nov 26, 2024
* Cleanup docstrings for FFT APIs

* rename   library name to kokkos-fft in docs

* rename KokkosFFT into kokkos-fft in README.md

* fix: doxygenfunction of fftshift and ifftshift

* fix: new line at eof in rst files

---------

Co-authored-by: Yuuichi Asahi <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants