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

Hiding attribute values that are not useful #1625

Merged
merged 1 commit into from
Jan 25, 2024

Conversation

zachmprince
Copy link
Contributor

What is the change?

In the PDF build of the docs, there are some instances of overly verbose and extremely long content that was automatically generated. These are a few of them that I found:

  • List of Nuclides table. Now this is only built with the PDF
  • energyGroups.GROUP_STRUCTURE
  • constant.DPA_CROSS_SECTIONS
  • test_customIsotopics.TestCustomIsotopics.yamlString

The last three are removed using :meta hide-value: which tells sphinx to not display the value of the attribute.

Why is the change being made?

Ongoing SQA effort


Checklist

  • The release notes (location doc/release/0.X.rst) are up-to-date with any important changes.
  • The documentation is still up-to-date in the doc folder.
  • If any requirements were affected, mention it in the release notes.
  • The dependencies are still up-to-date in pyproject.toml.

@zachmprince zachmprince added the documentation Improvements or additions to documentation label Jan 25, 2024
@@ -22,6 +22,8 @@
Notes
-----
This data structure can be updated by plugins with design-specific dpa data.

:meta hide-value:
Copy link
Member

@john-science john-science Jan 25, 2024

Choose a reason for hiding this comment

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

What does this do? (Sorry.) I have only seen this to hide an attribute from the docs.

Copy link
Member

Choose a reason for hiding this comment

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

Are you trying to hide the "Notes"?

Copy link
Contributor Author

@zachmprince zachmprince Jan 25, 2024

Choose a reason for hiding this comment

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

This explains it better than I can:
image

It basically just skips rendering the default value for the attribute.

@zachmprince zachmprince merged commit 9b9f82b into terrapower:main Jan 25, 2024
11 checks passed
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