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

Adding Requirements and QA to Docs #2076

Draft
wants to merge 15 commits into
base: main
Choose a base branch
from
Draft

Adding Requirements and QA to Docs #2076

wants to merge 15 commits into from

Conversation

john-science
Copy link
Member

@john-science john-science commented Feb 5, 2025

What is the change?

Here I add a "QA Documentation" section to the ARMI docs. This section will have:

  • Open-Sourced ARMI Requirements
  • Software Requirements Specification Document (SRSD)
  • Software Design and Implementation Document (SDID)
  • Software Test Report (STR)
  • Software Change Requests (SCRs)
    • This will be the more formal, SQA version of "release notes".

Why is the change being made?

close #2064

This is part of on-going work to improve the documentation of ARMI's high-level design requirements, and to open-source that information.


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.

@john-science john-science added the documentation Improvements or additions to documentation label Feb 5, 2025
@john-science
Copy link
Member Author

Okay, this appears to work fine. Here are some examples. First, the TOC at the top now includes this:

image

The sphinx-needs tooling is working:

image

image

The SDID looks fine:

image

The STR matrix is working:

image

image

@john-science
Copy link
Member Author

Okay, this is working great.

But I am now getting a TON of Sphinx warnings:

WARNING: Ignored `filter:progid:DXImageTransform.Microsoft.gradient(GradientType=0,StartColorStr="#f9f9f9", EndColorStr="#e0e0e0")` at 16:4443, unknown property.
WARNING: Ignored `text-shadow:0 1px 0 #c4def1` at 16:4687, unknown property.
WARNING: Ignored `background-image:-webkit-linear-gradient(top, #bddef4 0%, #79ace9 100%)` at 16:4753, invalid value.
WARNING: Ignored `background-image:-o-linear-gradient(top, #f0f0f0 0%, #dadada 100%)` at 16:6528, invalid value.
WARNING: Ignored `filter:progid:DXImageTransform.Microsoft.gradient(GradientType=0,StartColorStr="#f0f0f0", 
WARNING: Ignored `box-shadow:0 0 3px #444` at 28:2080, unknown property.
WARNING: Anchor defined twice: 'setting-up-the-blueprints'
WARNING: Anchor defined twice: 'nuclide-flags'
WARNING: Anchor defined twice: 'defining-fuel-management'
WARNING: Anchor defined twice: 'id13'
WARNING: Anchor defined twice: 'new-features'
WARNING: Anchor defined twice: 'api-changes'
WARNING: Anchor defined twice: 'bug-fixes'
WARNING: Anchor defined twice: 'quality-work'
WARNING: Anchor defined twice: 'bug-fixes'
WARNING: Anchor defined twice: 'quality-work'
WARNING: Anchor defined twice: 'subpackages'
WARNING: Anchor defined twice: 'submodules'
WARNING: Anchor defined twice: 'T_ARMI_MAT_PROPERTIES1'
WARNING: Anchor defined twice: 'T_ARMI_MAT_FLUID0'
WARNING: Anchor defined twice: 'submodules'
WARNING: Anchor defined twice: 'id1'
WARNING: Anchor defined twice: 'id2'
WARNING: Anchor defined twice: 'I_ARMI_MAT_FLUID'

The docs look fine though.

@john-science john-science requested a review from ntouran February 7, 2025 18:39
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.

Open-Source ARMI's Requirements
1 participant