Skip to content

Commit

Permalink
Fix gallery build in docs.
Browse files Browse the repository at this point in the history
These fixes were all informed by the sphinx warnings during build.
The labels weren't being applied correctly in the gallery and made
it look bad. Looks good now.
  • Loading branch information
ntouran committed Feb 6, 2025
1 parent 9c27b36 commit 47b3d7c
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 0 deletions.
6 changes: 6 additions & 0 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
All configuration values have a default; values that are commented out
serve to show the default.
"""

# ruff: noqa: E402
import datetime
import inspect
Expand Down Expand Up @@ -359,6 +360,11 @@ def setup(app):
exclude_patterns = [
"**/Python27*",
"**/ccl*",
# prevent sphinx-gallery from causing duplicate source file errors
"gallery/**/*.ipynb",
"gallery/**/*.md5",
"gallery/**/*.zip",
"gallery/**/*.json",
"**.ipynb_checkpoints",
"_build",
] # , '**/tests*']
Expand Down
2 changes: 2 additions & 0 deletions doc/gallery-src/framework/run_chartOfNuclides.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,9 @@
Our :ref:`extended tutorial for nuclides </tutorials/nuclide_demo.ipynb>` and
detailed :py:mod:`nucDirectory docs <armi.nucDirectory>` may also be of interest.
"""

import matplotlib.pyplot as plt

from armi import configure
Expand Down
2 changes: 2 additions & 0 deletions doc/gallery-src/framework/run_fuelManagement.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
# limitations under the License.
"""
Fuel management in a LWR.
=========================
Demo of locating and swapping assemblies in a core with Cartesian geometry. Given a burnup
distribution, this swaps high burnup assemblies with low ones.
Expand All @@ -26,6 +27,7 @@
ARMI to do fuel management. Thus, this example applies a dummy burnup distribution for
demonstration purposes.
"""

# Tell the gallery to feature the 2nd image
# sphinx_gallery_thumbnail_number = 2
import math
Expand Down

0 comments on commit 47b3d7c

Please sign in to comment.