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

Reducing warnings while building the docs #1959

Merged
merged 10 commits into from
Oct 18, 2024
Merged

Reducing warnings while building the docs #1959

merged 10 commits into from
Oct 18, 2024

Conversation

john-science
Copy link
Member

@john-science john-science commented Oct 17, 2024

What is the change?

The goal of this PR is actually two-fold:

  1. Un-break the doc build.
    • A recent PR broke the doc build, because running the docs means running a test reactor, which moved.
  2. Get rid of 1,000 warnings when we build the docs.
    • We have impl and test tags for Sphinx Needs requirements in ARMI, but the requirements aren't in ARMI, so this raises many warnings when building the docs. I just suppress those.

Why is the change being made?

You can see proof that this doc build ran and worked correctly here.

close #1876


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 Oct 17, 2024
@john-science john-science changed the title Reducing warnings while building the docs. Reducing warnings while building the docs Oct 18, 2024
@john-science john-science merged commit eef58dd into main Oct 18, 2024
19 checks passed
@john-science john-science deleted the fix_doc_build branch October 18, 2024 22:04
drewj-tp added a commit that referenced this pull request Oct 21, 2024
* origin/main:
  Updating cluster settings (#1958)
  Reducing warnings while building the docs (#1959)
  Moving anl-afci-177 test files to their own directory (#1957)
drewj-tp added a commit that referenced this pull request Oct 23, 2024
…xial-linkage

* origin/main:
  Loading some ARMI DBs without the App that created them (#1917)
  Revert "Revert "Updating cluster settings (#1958)" (#1965)" (#1969)
  Allowing users to define flag names with digits (#1966)
  Revert "Updating cluster settings (#1958)" (#1965)
  Updating cluster settings (#1958)
  Reducing warnings while building the docs (#1959)
  Moving anl-afci-177 test files to their own directory (#1957)
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.

Building docs spits out many sphinx-needs warnings
2 participants