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

add rst templates for adding documentation #362

Closed
3 tasks
nmm0 opened this issue Apr 12, 2023 · 4 comments · Fixed by #385
Closed
3 tasks

add rst templates for adding documentation #362

nmm0 opened this issue Apr 12, 2023 · 4 comments · Fixed by #385
Assignees
@nmm0 @ajpowelsnl

Comments

@nmm0
Copy link
Contributor

nmm0 commented Apr 12, 2023

Probably will have one for:

  • classes
  • free functions
  • "concepts"
@nmm0 nmm0 self-assigned this Apr 12, 2023
@ajpowelsnl ajpowelsnl self-assigned this Apr 17, 2023
@nmm0 nmm0 mentioned this issue May 22, 2023
Merged
@ajpowelsnl
Copy link
Contributor

@nmm0 -- can we close, given #385?

@masterleinad
Copy link
Contributor

@nmm0 -- can we close, given #385?

#385 is not merged.

@ajpowelsnl
Copy link
Contributor

@nmm0 -- can we close, given #385?

#385 is not merged.

Understood. #362 is a subset of #385, and no information is lost by closing #362.

@nmm0
Copy link
Contributor Author

nmm0 commented Aug 15, 2023

@nmm0 -- can we close, given #385?

#385 is not merged.

Understood. #362 is a subset of #385, and no information is lost by closing #362.

This issue will automatically be closed when the PR is merged since it is linked

crtrott added a commit that referenced this issue Aug 15, 2023
@nmm0 @crtrott
#362: add basic rst template for api documentation (#385)
52443dd 
* add basic rst template for api documentation

* fix some syntax issues and clarify some of the times where destructor and examples should be used

* add .venv to gitignore

* move template to inside the source directory

* organize templates so they are rendered by the build process and can be found inside of the Contributing page

* document versionchanged, etc

* use c++-style deprecated and address some PR feedback

* fix some typos and update the comment on deprecated

* Apply suggestions from code review

---------

Co-authored-by: Christian Trott <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@nmm0 nmm0

@ajpowelsnl ajpowelsnl

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

#362: add basic rst template for api documentation nmm0/kokkos-core-wiki
3 participants
@masterleinad @nmm0 @ajpowelsnl