crp/OpenMC
1
0
Fork 0
mirror of https://github.com/openmc-dev/openmc.git synced 2026-07-28 14:15:42 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Use nbsphinx for rendering Jupyter notebooks in documentation

Browse source
This commit is contained in:
Paul Romano 2020-10-14 07:57:52 -05:00
parent c5f66a3af5
commit 7228bba307
52 changed files with 101 additions and 568 deletions
Download patch file Download diff file Expand all files Collapse all files

13
docs/source/examples/cad-geom.rst
View file

@ -1,13 +0,0 @@
.. _notebook_cad-geom:
==========================
Using CAD-Based Geometries
==========================
.. only:: html
.. notebook:: ../../../examples/jupyter/cad-based-geometry.ipynb
.. only:: latex
IPython notebooks must be viewed in the online HTML documentation.

13
docs/source/examples/candu.rst
View file

@ -1,13 +0,0 @@
.. _notebook_candu:
=======================
Modeling a CANDU Bundle
=======================
.. only:: html
.. notebook:: ../../../examples/jupyter/candu.ipynb
.. only:: latex
IPython notebooks must be viewed in the online HTML documentation.

13
docs/source/examples/expansion-filters.rst
View file

@ -1,13 +0,0 @@
.. _notebook_expansion:
=====================
Functional Expansions
=====================
.. only:: html
.. notebook:: ../../../examples/jupyter/expansion-filters.ipynb
.. only:: latex
IPython notebooks must be viewed in the online HTML documentation.

13
docs/source/examples/hexagonal.rst
View file

@ -1,13 +0,0 @@
.. _notebook_hexagonal:
===========================
Modeling Hexagonal Lattices
===========================
.. only:: html
.. notebook:: ../../../examples/jupyter/hexagonal-lattice.ipynb
.. only:: latex
IPython notebooks must be viewed in the online HTML documentation.

18
docs/source/examples/index.rst
View file

@ -23,7 +23,7 @@ General Usage
search
nuclear-data
nuclear-data-resonance-covariance
pincell-depletion
pincell_depletion
--------
Geometry
@ -32,14 +32,14 @@ Geometry
.. toctree::
:maxdepth: 1
hexagonal
hexagonal-lattice
triso
candu
cad-geom
cad-based-geometry
------------------------------------
Multi-Group Cross Section Generation
------------------------------------
-----------------------------------
Multigroup Cross Section Generation
-----------------------------------
.. toctree::
:maxdepth: 1
@ -50,9 +50,9 @@ Multi-Group Cross Section Generation
mdgxs-part-i
mdgxs-part-ii
----------------
Multi-Group Mode
----------------
---------------
Multigroup Mode
---------------
.. toctree::
:maxdepth: 1

13
docs/source/examples/mdgxs-part-i.rst
View file

@ -1,13 +0,0 @@
.. _notebook_mdgxs_part_i:
===================================================================
Multi-Group (Delayed) Cross Section Generation Part I: Introduction
===================================================================
.. only:: html
.. notebook:: ../../../examples/jupyter/mdgxs-part-i.ipynb
.. only:: latex
IPython notebooks must be viewed in the online HTML documentation.

13
docs/source/examples/mdgxs-part-ii.rst
View file

@ -1,13 +0,0 @@
.. _notebook_mdgxs_part_ii:
=========================================================================
Multi-Group (Delayed) Cross Section Generation Part II: Advanced Features
=========================================================================
.. only:: html
.. notebook:: ../../../examples/jupyter/mdgxs-part-ii.ipynb
.. only:: latex
IPython notebooks must be viewed in the online HTML documentation.

13
docs/source/examples/mg-mode-part-i.rst
View file

@ -1,13 +0,0 @@
.. _notebook_mg_mode_part_i:
=====================================
Multi-Group Mode Part I: Introduction
=====================================
.. only:: html
.. notebook:: ../../../examples/jupyter/mg-mode-part-i.ipynb
.. only:: latex
IPython notebooks must be viewed in the online HTML documentation.

13
docs/source/examples/mg-mode-part-ii.rst
View file

@ -1,13 +0,0 @@
.. _notebook_mg_mode_part_ii:
=============================================================
Multi-Group Mode Part II: MGXS Library Generation With OpenMC
=============================================================
.. only:: html
.. notebook:: ../../../examples/jupyter/mg-mode-part-ii.ipynb
.. only:: latex
IPython notebooks must be viewed in the online HTML documentation.

13
docs/source/examples/mg-mode-part-iii.rst
View file

@ -1,13 +0,0 @@
.. _notebook_mg_mode_part_iii:
====================================================
Multi-Group Mode Part III: Advanced Feature Showcase
====================================================
.. only:: html
.. notebook:: ../../../examples/jupyter/mg-mode-part-iii.ipynb
.. only:: latex
IPython notebooks must be viewed in the online HTML documentation.

13
docs/source/examples/mgxs-part-i.rst
View file

@ -1,13 +0,0 @@
.. _notebook_mgxs_part_i:
=========================
MGXS Part I: Introduction
=========================
.. only:: html
.. notebook:: ../../../examples/jupyter/mgxs-part-i.ipynb
.. only:: latex
IPython notebooks must be viewed in the online HTML documentation.

13
docs/source/examples/mgxs-part-ii.rst
View file

@ -1,13 +0,0 @@
.. _notebook_mgxs_part_ii:
===============================
MGXS Part II: Advanced Features
===============================
.. only:: html
.. notebook:: ../../../examples/jupyter/mgxs-part-ii.ipynb
.. only:: latex
IPython notebooks must be viewed in the online HTML documentation.

13
docs/source/examples/mgxs-part-iii.rst
View file

@ -1,13 +0,0 @@
.. _notebook_mgxs_part_iii:
========================
MGXS Part III: Libraries
========================
.. only:: html
.. notebook:: ../../../examples/jupyter/mgxs-part-iii.ipynb
.. only:: latex
IPython notebooks must be viewed in the online HTML documentation.

13
docs/source/examples/nuclear-data-resonance-covariance.rst
View file

@ -1,13 +0,0 @@
.. _notebook_nuclear_data_resonance_covariance:
==================================
Nuclear Data: Resonance Covariance
==================================
.. only:: html
.. notebook:: ../../../examples/jupyter/nuclear-data-resonance-covariance.ipynb
.. only:: latex
IPython notebooks must be viewed in the online HTML documentation.

13
docs/source/examples/nuclear-data.rst
View file

@ -1,13 +0,0 @@
.. _notebook_nuclear_data:
============
Nuclear Data
============
.. only:: html
.. notebook:: ../../../examples/jupyter/nuclear-data.ipynb
.. only:: latex
IPython notebooks must be viewed in the online HTML documentation.

13
docs/source/examples/pandas-dataframes.rst
View file

@ -1,13 +0,0 @@
.. _examples_pandas:
=================
Pandas Dataframes
=================
.. only:: html
.. notebook:: ../../../examples/jupyter/pandas-dataframes.ipynb
.. only:: latex
IPython notebooks must be viewed in the online HTML documentation.

14
docs/source/examples/pincell-depletion.rst
View file

@ -1,14 +0,0 @@
.. _notebook_depletion:
=================
Pincell Depletion
=================
.. only:: html
.. notebook:: ../../../examples/jupyter/pincell_depletion.ipynb
.. only:: latex
IPython notebooks must be viewed in the online HTML documentation.

13
docs/source/examples/pincell.rst
View file

@ -1,13 +0,0 @@
.. _notebook_pincell:
===================
Modeling a Pin-Cell
===================
.. only:: html
.. notebook:: ../../../examples/jupyter/pincell.ipynb
.. only:: latex
IPython notebooks must be viewed in the online HTML documentation.

13
docs/source/examples/post-processing.rst
View file

@ -1,13 +0,0 @@
.. _notebook_post_processing:
===============
Post Processing
===============
.. only:: html
.. notebook:: ../../../examples/jupyter/post-processing.ipynb
.. only:: latex
IPython notebooks must be viewed in the online HTML documentation.

13
docs/source/examples/search.rst
View file

@ -1,13 +0,0 @@
.. _notebook_search:
==================
Criticality Search
==================
.. only:: html
.. notebook:: ../../../examples/jupyter/search.ipynb
.. only:: latex
IPython notebooks must be viewed in the online HTML documentation.

11
docs/source/examples/tally-arithmetic.rst
View file

@ -1,11 +0,0 @@
================
Tally Arithmetic
================
.. only:: html
.. notebook:: ../../../examples/jupyter/tally-arithmetic.ipynb
.. only:: latex
IPython notebooks must be viewed in the online HTML documentation.

13
docs/source/examples/triso.rst
View file

@ -1,13 +0,0 @@
.. _notebook_triso:
========================
Modeling TRISO Particles
========================
.. only:: html
.. notebook:: ../../../examples/jupyter/triso.ipynb
.. only:: latex
IPython notebooks must be viewed in the online HTML documentation.

13
docs/source/examples/unstructured-mesh-part-i.rst
View file

@ -1,13 +0,0 @@
.. _notebook_unstructured_mesh_part_i:
===============================
Unstructured Mesh: Introduction
===============================
.. only:: html
.. notebook:: ../../../examples/jupyter/unstructured-mesh-part-i.ipynb
.. only:: latex
IPython notebooks must be viewed in the online HTML documentation.

13
docs/source/examples/unstructured-mesh-part-ii.rst
View file

@ -1,13 +0,0 @@
.. _notebook_unstructured_mesh_part_ii:
===================================================================================
Unstructured Mesh: Unstructured Mesh Tallies with CAD and Point Cloud Visualization
===================================================================================
.. only:: html
.. notebook:: ../../../examples/jupyter/unstructured-mesh-part-ii.ipynb
.. only:: latex
IPython notebooks must be viewed in the online HTML documentation.