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

Update user guide. #133

Merged
merged 6 commits into from
Jan 4, 2024
Merged

Update user guide. #133

merged 6 commits into from
Jan 4, 2024

Conversation

pelesh
Copy link
Collaborator

@pelesh pelesh commented Dec 28, 2023

Reorganizing ReSolve's documentation. This is work in progress; the PR has been created to provide preview to other developers and discuss how we want to organize docs.

  • Doxygen generated docs with modifications from this PR can be previewed here.
  • Sphyinx generated docs with modifications from this PR are available here.

@pelesh pelesh added the documentation Improvements or additions to documentation label Dec 28, 2023
@pelesh pelesh requested a review from ryandanehy December 28, 2023 23:39
@pelesh pelesh self-assigned this Dec 28, 2023
@pelesh pelesh marked this pull request as draft December 28, 2023 23:39
@pelesh pelesh marked this pull request as ready for review January 1, 2024 01:10
docs/index.rst Outdated Show resolved Hide resolved
Copy link
Collaborator

@ryandanehy ryandanehy left a comment

Choose a reason for hiding this comment

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

I have some small suggestions that I left as comments but looks good.

@pelesh pelesh merged commit ec792e3 into develop Jan 4, 2024
7 of 8 checks passed
pelesh added a commit that referenced this pull request Jan 4, 2024
* Update user guide.

* Reorganize documentation directories

* Add docs on HPCToolkit profiling

* Add rocprof instructions to the documentation.
@pelesh pelesh deleted the user-doc-dev branch February 21, 2024 15:35
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants