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

Docs: cleanup install guide #637

Merged
merged 38 commits into from
Jan 18, 2025
Merged

Docs: cleanup install guide #637

merged 38 commits into from
Jan 18, 2025

Conversation

gardner48
Copy link
Member

@gardner48 gardner48 commented Jan 12, 2025

  • Separate sections for installing with Spack and CMake
  • Co-locate Linux, Windows, and HPC install instructions in CMake section
  • Remove ccmake steps to focus on simpler cmake steps
  • Create subsections for related CMake options
  • Combine TPL sections with related TPL options
  • Add cross-references to corresponding TPL modules
  • Add configuration examples for all TPLs
  • Combine addons section with CMake option
  • Create subsections for table of headers and libraries
  • Add CMake targets to tables
  • Add missing headers and libraries
  • Remove deprecated headers
  • Remove duplicate text

@gardner48
Copy link
Member Author

The diff of Install.rst in not very helpful. It's probably easier to compare the online versions:

drreynolds
drreynolds previously approved these changes Jan 13, 2025
Copy link
Collaborator

@Steven-Roberts Steven-Roberts left a comment

Choose a reason for hiding this comment

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

Just a few minor comments. Quite thorough, and the tables with header/linking info are helpful.

doc/shared/sundials/Install.rst Outdated Show resolved Hide resolved
doc/shared/sundials/Install.rst Outdated Show resolved Hide resolved
doc/shared/sundials/Install.rst Show resolved Hide resolved
doc/shared/sundials/Install.rst Show resolved Hide resolved
Fix typos in docs

Co-authored-by: Steven Roberts <[email protected]>
@gardner48 gardner48 added this to the SUNDIALS Next milestone Jan 16, 2025
@gardner48 gardner48 added the docs label Jan 16, 2025
@gardner48 gardner48 merged commit cc5e58c into develop Jan 18, 2025
46 of 47 checks passed
@gardner48 gardner48 deleted the docs/reorg-install-guide branch January 18, 2025 17:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants