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

Fixing hex assembly rotation docs #2027

Merged
merged 4 commits into from
Dec 3, 2024
Merged

Fixing hex assembly rotation docs #2027

merged 4 commits into from
Dec 3, 2024

Conversation

drewj-tp
Copy link
Contributor

@drewj-tp drewj-tp commented Dec 2, 2024

What is the change?

Caught some typos and errors in docs that were previously introduced by me that made the docs render poorly.

Why is the change being made?

Docs should be buildable and look nice.

Fix bad doc directive in block parameters

Resolves the following error from doc
builds

/home/runner/work/armi/armi/doc/user/spatial_block_parameters.rst:126:
ERROR: Unknown directive type "seelso".

.. seelso::

    The :ref:`LWR tutorial <walkthrough-lwr>` contains additional
examples for working with sub-block grids.

Move discussion on getOptimalAssemblyRotation out of Notes section

This doesn't seem to render well inside a note box. Not sure why it is not a unique section but its own admonition box


Checklist

  • The release notes have been updated if necessary.
  • The documentation is still up-to-date in the doc folder.
  • The dependencies are still up-to-date in pyproject.toml.

Resolves the following error from doc
[builds](https://github.com/terrapower/armi/actions/runs/12128309602/job/33814420871)
```
/home/runner/work/armi/armi/doc/user/spatial_block_parameters.rst:126:
ERROR: Unknown directive type "seelso".

.. seelso::

    The :ref:`LWR tutorial <walkthrough-lwr>` contains additional
examples for working with sub-block grids.
```
This doesn't seem to render well inside a note box. Not sure why it is not a unique section but its own admonition box
@drewj-tp drewj-tp added the documentation Improvements or additions to documentation label Dec 2, 2024
@drewj-tp drewj-tp requested a review from john-science December 2, 2024 23:54
@drewj-tp drewj-tp self-assigned this Dec 2, 2024
@drewj-tp drewj-tp changed the title Drewj/doc touch ups Hex assembly rotate doc fixes Dec 3, 2024
@john-science john-science changed the title Hex assembly rotate doc fixes Fixing hex assembly rotation docs Dec 3, 2024
@john-science john-science merged commit 4a109cc into main Dec 3, 2024
22 checks passed
@john-science john-science deleted the drewj/doc-touch-ups branch December 3, 2024 00:18
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