Skip to content

Add layout footer correction#35

Merged
guyer merged 5 commits intousnistgov:mainfrom
jaclark5:update_docs
Mar 2, 2026
Merged

Add layout footer correction#35
guyer merged 5 commits intousnistgov:mainfrom
jaclark5:update_docs

Conversation

@jaclark5
Copy link
Copy Markdown
Contributor

Despite the warning that sphinx_rtd_themes being incompatible with this GH Action, I pushed through using the mdanalysis_sphinx_theme which is based on the rtd theme. I'm not sure if this was the intention behind the warning, but the issue I saw is that the NIST footer was stuck at the top of the page.

By using the suggestion added to the docks here, I was able to get the NIST header and footer to be correctly placed in the documentation. See zenowrapper for an example.

@guyer
Copy link
Copy Markdown
Member

guyer commented Feb 18, 2026

Yes, I'm pretty sure this is the source of the warning about sphinx_rtd_theme. I think there should be a cross-reference from those warnings to your layout template explanation.

Also discovered (and will fix have fixed)

@jaclark5
Copy link
Copy Markdown
Contributor Author

@guyer is there anything I need to do for this PR?

@guyer
Copy link
Copy Markdown
Member

guyer commented Feb 28, 2026

@guyer is there anything I need to do for this PR?

@jaclark5 If you can, please troubleshoot the error in my review comment. I don't see anything obvious wrong with your jinja code-block, but sphinx errors and it does not appear in the generated docs.

I don't know why the CI passes anyway.

@jaclark5
Copy link
Copy Markdown
Contributor Author

jaclark5 commented Mar 1, 2026

@guyer I merged the main branch and fixed the docs issue. I needed a blank line after ..code-block
*facepalm*

I downloaded the artifacts and viewed the html locally, it looks as expected.

@guyer guyer merged commit d762358 into usnistgov:main Mar 2, 2026
1 check passed
@jaclark5 jaclark5 deleted the update_docs branch March 2, 2026 15:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants