Skip to content

Build docs reorg#1519

Merged
white238 merged 43 commits intodevelopfrom
task/white238/tpl_docs_reorg
Feb 2, 2026
Merged

Build docs reorg#1519
white238 merged 43 commits intodevelopfrom
task/white238/tpl_docs_reorg

Conversation

@white238
Copy link
Member

@white238 white238 commented Jan 9, 2026 •
edited
Loading

https://llnlsmith.readthedocs.io/en/task-white238-tpl_docs_reorg/sphinx/build_guide/index.html

  • Broke the mega-build page apart into a more "choose your own adventure" style docs that follows three phases.
  • Documented all config-build.py and CMake options
  • Documented all Spack variants for the Smith package
  • Ruthlessly got rid of the quickstart guide and merged all relevant info into appropriate pages because honestly there is no quick way to get going with Smith at this point and it was a trap for users

white238 added 30 commits January 28, 2026 15:19
@white238
first cut at deunifying build instructions
1e5c955
@white238
fix links and cleanup start of macos page
f3a0e42
@white238
fix toc
df3187c
@white238
fix list
3b7582d
@white238
slight tweak
9796746
@white238
fix toc?
a09400c
@white238
fix tags
6e21282
@white238
unhide toc
ca64a2a
@white238
dont ask
bc8292f
@white238
clean up build guide index
d8bbc50
@white238
small tweak
1eb598e
@white238
more consistent naming and labels
92c7e51
@white238
more labels
45e974a
@white238
move for labels
0d60802
@white238
add more basic structure
9ff9256
@white238
another crack at the structure
b89760a
@white238
add index
b27c597
@white238
try renaming the section to not conflict
c1b2f0a
@white238
try removing inner toctree
e246eb4
@white238
try something
a5d1403
@white238
limit titles on build guide
017855e
@white238
try updating sphinx
7b5b759
@white238
remove quickstart
54790d0
@white238
fix now broken labels
c5fbac6
@white238
clean up entry page
9c33c0d
@white238
add section on host-configs
154afb5
@white238
cleanup ubuntu instructions
865cb47
@white238
more docs
ed8f0c4
@white238
bold it
dff1126
@white238
flush out variants
a10e3da
@white238 white238 changed the title WIP: Build docs reorg Build docs reorg Jan 29, 2026
@white238 white238 added documentation Improvements or additions to documentation CS Computer science and software engineering labels Jan 29, 2026
@white238
Copy link
Member Author

white238 commented Jan 30, 2026

This is ready for review.

@white238
Copy link
Member Author

white238 commented Jan 30, 2026

Fixes #907

chapman39
chapman39 reviewed Jan 30, 2026
View reviewed changes
chapman39
chapman39 reviewed Jan 30, 2026
View reviewed changes
@white238 @chapman39
Update src/docs/sphinx/build_guide/build_tpls.rst
ec94f87 
Co-authored-by: Alex Tyler Chapman <100869159+chapman39@users.noreply.github.com>
chapman39
chapman39 reviewed Jan 30, 2026
View reviewed changes
chapman39
chapman39 reviewed Jan 30, 2026
View reviewed changes
chapman39
chapman39 reviewed Jan 30, 2026
View reviewed changes
@white238 @chapman39
Update src/docs/sphinx/build_guide/build_smith.rst
bacc620 
Co-authored-by: Alex Tyler Chapman <100869159+chapman39@users.noreply.github.com>
chapman39
chapman39 reviewed Jan 30, 2026
View reviewed changes
chapman39
chapman39 reviewed Jan 30, 2026
View reviewed changes
chapman39
chapman39 approved these changes Jan 30, 2026
View reviewed changes
Copy link
Collaborator

@chapman39 chapman39 left a comment

Choose a reason for hiding this comment

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

besides minor comments, lgtm. i think this is going to be very useful getting new users started.

tupek2
tupek2 approved these changes Jan 31, 2026
View reviewed changes
Copy link
Collaborator

@tupek2 tupek2 left a comment

Choose a reason for hiding this comment

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

Fantastic reorg.

@white238 @tupek2
Update src/docs/sphinx/build_guide/build_tpls.rst
eea8daf 
Co-authored-by: Michael Tupek <135926736+tupek2@users.noreply.github.com>
btalamini
btalamini approved these changes Feb 2, 2026
View reviewed changes
Copy link
Member

@btalamini btalamini left a comment

Choose a reason for hiding this comment

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

Thanks for undertaking this. I think it's a big step in the right direction.

src/docs/sphinx/build_guide/build_smith.rst
Copy link
Member

@btalamini btalamini Feb 2, 2026

Choose a reason for hiding this comment

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

This page looks great!

white238 and others added 3 commits February 2, 2026 14:02
@white238 @btalamini
Update src/docs/sphinx/build_guide/index.rst
95eacdd 
Co-authored-by: Brandon Talamini <30813018+btalamini@users.noreply.github.com>
@white238 @btalamini
Update src/docs/sphinx/build_guide/setup_system/setup_macos.rst
fa51f1b 
Co-authored-by: Brandon Talamini <30813018+btalamini@users.noreply.github.com>
@white238
address comments
51342cf
@white238 white238 merged commit eb34812 into develop Feb 2, 2026
14 of 16 checks passed
@white238 white238 deleted the task/white238/tpl_docs_reorg branch February 2, 2026 23:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@btalamini btalamini btalamini approved these changes

@chapman39 chapman39 chapman39 approved these changes

@tupek2 tupek2 tupek2 approved these changes

Assignees

No one assigned

Labels

CS Computer science and software engineering documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@white238 @btalamini @chapman39 @tupek2