Skip to content

Fixing material doc header levels#2545

Merged
opotowsky merged 4 commits into
mainfrom
doc_levels
May 25, 2026
Merged

Fixing material doc header levels#2545
opotowsky merged 4 commits into
mainfrom
doc_levels

Conversation

@john-science
Copy link
Copy Markdown
Member

@john-science john-science commented May 22, 2026

What is the change? Why is it being made?

The goal of this PR was to fix the RST header levels in the docs for the material input files. This was just a simple RST mistake.

HOWEVER, it looks like when we first made the original docs PR for this, we got a little wild with making in-line changes to the docs in the GH PR page... and that completely wrecked the docs in the RST format. They were Hideous and hard to read; no rhyme or reason to the line length at all. Anyway, I fixed that, so that's going to make this PR a mess to read. And I'm sorry about that.

close #2542

SCR Information

Change Type: docs

One-Sentence Rationale: Our users navigate the docs using the headers, so they should be ordered correctly.

One-line Impact on Requirements: NA


Checklist

@john-science john-science requested a review from opotowsky May 22, 2026 21:03
@john-science john-science added the documentation Improvements or additions to documentation label May 22, 2026
@john-science
Copy link
Copy Markdown
Member Author

@opotowsky The PDF looks like it works fine:

image image

Copy link
Copy Markdown
Member

@opotowsky opotowsky left a comment

Choose a reason for hiding this comment

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

Image

@opotowsky opotowsky merged commit a180859 into main May 25, 2026
10 checks passed
@opotowsky opotowsky deleted the doc_levels branch May 25, 2026 20:42
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.

Material docs heading levels

2 participants