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.

Sign up for GitHub

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

Jump to bottom

Fixing various doc build issues #1974

Merged
merged 7 commits into from
Oct 25, 2024
Merged

Fixing various doc build issues #1974

merged 7 commits into from
Oct 25, 2024

Conversation

ntouran
Copy link
Member

@ntouran ntouran commented Oct 25, 2024 •
edited by john-science
Loading

What is the change?

Fix numerous doc errors, one per commit.

Why is the change being made?

Because they were bugs and caused doc build errors.

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.

@ntouran
Fix a few broken PR links.
1bde7b1 
One was a typo, another was missing a >.
One was just duplicated, which needs a double-underscore...
@ntouran
Removed duplicated reference definitions.
2e17ff8 
Only one is needed. Others cause doc build warnings.

Also corrected typo with extra T.
@ntouran
Removed broken links to radialExpansion and axialExpansion.
82efa7f 
And rewrapped!
@ntouran
Fixed broken ref in docs.
0b1e34e
@john-science john-science added the documentation Improvements or additions to documentation label Oct 25, 2024
@john-science john-science changed the title Fix more doc build issues Fixing vairous doc build issues Oct 25, 2024
@ntouran ntouran changed the title Fixing vairous doc build issues Fixing various doc build issues Oct 25, 2024
john-science
john-science approved these changes Oct 25, 2024
View reviewed changes
Copy link
Member

@john-science john-science left a comment

Choose a reason for hiding this comment

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

These are all straight-forward, obvious improvements.

Thanks!

@ntouran
Copy link
Member Author

ntouran commented Oct 25, 2024

Can I add one more commit to this?

@john-science
Copy link
Member

Can I add one more commit to this?

Sure!

@ntouran
Fix more broken internal links in docs.
39a4d85
@ntouran
Remove duplicated installation instructions.
3c79805 
These were rendering in their own section and then
a second time in the user guide. Now there's just one.
@partofthething
Copy link

ok ready!

john-science
john-science approved these changes Oct 25, 2024
View reviewed changes
Copy link
Member

@john-science john-science left a comment

Choose a reason for hiding this comment

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

Great!

@john-science john-science merged commit aadd5cd into terrapower:main Oct 25, 2024
11 checks passed
drewj-tp added a commit that referenced this pull request Oct 29, 2024
@drewj-tp
Merge branch 'main' into drewj/improve-assem-axial-linkage
038b75e 
* main:
  Fixing HexBlock docstrings (#1981)
  Removing a duplicate hex rotation impl tag (#1979)
  Avoiding closing plots that are meant to be interactive (#1978)
  Ensuring HexBlock.rotate updates child spatial locators (#1943)
  Add new memory runLog info to memoryProfiler.py  (#1970)
  Fixing various doc build issues (#1974)
  Hiding sphinx-needs warnings during doc build (#1973)
  Fixing warnings in CLI startup (#1972)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@john-science john-science john-science approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@ntouran @john-science @partofthething