Add schedule processing capabilities, and cleanups.

Fixes a few config issues and warnings
Removes double-import of GDC
Adds mpxj dependency for scheduling
This commit is contained in:
Nick Touran 2025-11-28 14:49:50 -05:00
parent 56a79e3562
commit 7d09eaecb7
10 changed files with 388 additions and 8 deletions

View file

@ -34,6 +34,7 @@ extensions = [
"sphinx_needs",
"myst_parser",
"sphinxcontrib.bibtex",
"sphinx.ext.todo",
"sphinxcontrib.glossaryused",
"sphinx.ext.imgmath",
"sphinxcontrib.datatemplates",
@ -42,6 +43,7 @@ extensions = [
# "sphinx.ext.imgconverter", # SVG to png but rasterizes and bad
"sphinxcontrib.inkscapeconverter", # SVG to pdf without rasterizing
"sphinx_timeline",
"nrsk.schedule.load_schedule",
]
# Add any paths that contain templates here, relative to this directory.
@ -50,7 +52,7 @@ templates_path = ["_templates"]
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []
exclude_patterns = ["generated_assets"]
# -- Options for HTML output -------------------------------------------------
@ -126,6 +128,7 @@ rst_prolog = f"""
# will need to move relevant refs somewhere
# more reusable, like into the repo?
bibtex_bibfiles = ["/pool/Reading/refs.bib"]
bibtex_cache = "none" # refresh without wiping build
mermaid_cmd = "./node_modules/.bin/mmdc"
# enable pdf cropping of mermaid diagrams for fit
@ -134,3 +137,4 @@ mermaid_version = "10.6.1"
# Sphinx Needs config
needs_include_needs = True # turn off to hide all needs (e.g. for working docs)
needs_extra_options = ["basis"]

View file

@ -9,6 +9,7 @@
purpose/index
organization/index
procedures/index
project/index
bibliography
requirements/index
glossary

View file

@ -22,7 +22,7 @@ Systems
Documents and records are managed in the following systems.
.. datatemplate:yaml::
:source: /_data/systems.yaml
:source: /_data/it-systems.yaml
{{ make_list_table_from_mappings(
[('Name', 'name'), ('Use case(s)', 'use-cases'), ('Location', 'location')],

View file

@ -1,6 +1,6 @@
Writer's Guide
--------------
See :ref:`meyerProcedureWriterGuide1993`
See :cite:p:`meyerProcedureWritersGuide1993`
See :ref:`wieringaProcedureWritingDomains1991`.
See :cite:p:`wieringaProcedureWritingDomains1991`.

View file

@ -1,4 +1,11 @@
.. thinking of putting like, all the calcs you have to do during design,
calibrations during commissioning,
work during operations. This would be where we could be like, "Hey don't forget
to include impurities in shielding calculations"
to include impurities in shielding calculations"
.. toctree::
:glob:
:maxdepth: 2
*

View file

@ -0,0 +1,4 @@
Project Schedule
################
.. schedule:: _data/schedule.yaml

View file

@ -26,7 +26,7 @@ and `RG 1.232 <https://www.nrc.gov/docs/ML1732/ML17325A611.pdf>`_.
:filter: id.startswith("R_GDC")
:columns: id
.. include:: /../generated_assets/10-cfr-50-app-a-list.rst
.. include:: /generated_assets/10-cfr-50-app-a-list.rst
Appendix B
@ -43,6 +43,6 @@ Appendix B
.. :basis: Flowed down
.. needimport:: /../generated_assets/10-cfr-50-app-b.json
.. needimport:: /generated_assets/10-cfr-50-app-b.json
:collapse: true
:tags: ["quality"]