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

Replace ppt generated illustrations for graphviz #1186

Merged
merged 1 commit into from
Feb 15, 2023

Conversation

albeanth
Copy link
Member

@albeanth albeanth commented Feb 15, 2023

Description

In the documentation additions in #1033, the loose and tight coupling illustrations had Powerpoint generated illustrations as placeholders. This PR replaces those pngs with graphviz generated illustrations that are hopefully clearer and more maintainable.

#1033 (comment)


Checklist

  • This PR has only one purpose or idea.
  • Tests have been added/updated to verify that the new/changed code works.
    • Just documentation, no tests to be added.
  • The release notes (location doc/release/0.X.rst) are up-to-date with any bug fixes or new features.
    • Not changing text in documentation, just images.
  • The documentation is still up-to-date in the doc folder.
  • The dependencies are still up-to-date in setup.py.

@albeanth albeanth added the documentation Improvements or additions to documentation label Feb 15, 2023
@albeanth
Copy link
Member Author

Here's what the new images look like when the docs are built.
image

Copy link
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.

nice!

@john-science
Copy link
Member

I love it! @albeanth

Are you SURE we don't need to add any dependencies to the repo to make this work?

If so, GREAT, I'm thrilled.

@albeanth
Copy link
Member Author

I love it! @albeanth

Are you SURE we don't need to add any dependencies to the repo to make this work?

If so, GREAT, I'm thrilled.

Yep! No additional dependencies.

The one thing that came up when I was making this. I didn't see any reference in the docs about having to run https://github.com/terrapower/armi/blob/main/doc/requirements-docs.txt. If that is not run, then the docs do build locally, but they're all messed up.

@john-science john-science merged commit 387d1ee into terrapower:main Feb 15, 2023
@albeanth albeanth deleted the updateGraphicsForTC branch February 15, 2023 21:31
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.

3 participants