From d460e51fb772fe53121974c1daaa6996877298d0 Mon Sep 17 00:00:00 2001 From: Will Boyd Date: Fri, 29 Apr 2016 23:27:59 -0400 Subject: [PATCH 1/3] Moved Jupyter Notebook examples to top of Python API page --- docs/source/pythonapi/index.rst | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/source/pythonapi/index.rst b/docs/source/pythonapi/index.rst index 3bedaf2c7b..1631976e67 100644 --- a/docs/source/pythonapi/index.rst +++ b/docs/source/pythonapi/index.rst @@ -13,6 +13,20 @@ online. We recommend going through the modules from Codecademy_ and/or the `Scipy lectures`_. The full API documentation serves to provide more information on a given module or class. +------------------------- +Example Jupyter Notebooks +------------------------- + +.. toctree:: + :maxdepth: 1 + + examples/post-processing + examples/pandas-dataframes + examples/tally-arithmetic + examples/mgxs-part-i + examples/mgxs-part-ii + examples/mgxs-part-iii + ------------------------------------ :mod:`openmc` -- Basic Functionality ------------------------------------ @@ -271,20 +285,6 @@ Multi-group Cross Section Libraries openmc.mgxs.Library -------------------------- -Example Jupyter Notebooks -------------------------- - -.. toctree:: - :maxdepth: 1 - - examples/post-processing - examples/pandas-dataframes - examples/tally-arithmetic - examples/mgxs-part-i - examples/mgxs-part-ii - examples/mgxs-part-iii - .. _Jupyter: https://jupyter.org/ .. _NumPy: http://www.numpy.org/ .. _Codecademy: https://www.codecademy.com/tracks/python From 6fc37fb99cf277dfe364559edf642a78f90762b4 Mon Sep 17 00:00:00 2001 From: Will Boyd Date: Fri, 29 Apr 2016 23:31:12 -0400 Subject: [PATCH 2/3] Added a link to Read the Docs to homepage --- docs/source/index.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 54ba825e58..7edc560e2e 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -13,11 +13,12 @@ OpenMC was originally developed by members of the `Computational Reactor Physics Group`_ at the `Massachusetts Institute of Technology`_ starting in 2011. Various universities, laboratories, and other organizations now contribute to the development of OpenMC. For more information on OpenMC, feel -free to send a message to the User's Group `mailing list`_. +free to send a message to the User's Group `mailing list`_. Documentation for the latest version of the develop branch can be found on `Read the Docs`_. .. _Computational Reactor Physics Group: http://crpg.mit.edu .. _Massachusetts Institute of Technology: http://web.mit.edu .. _mailing list: https://groups.google.com/forum/?fromgroups=#!forum/openmc-users +.. _Read the Docs: http://openmc.readthedocs.io/en/latest/ .. only:: html From e5432e84a8c5398296c6229a1ab073f86697d58a Mon Sep 17 00:00:00 2001 From: Will Boyd Date: Sun, 1 May 2016 01:25:45 -0400 Subject: [PATCH 3/3] Improved wording of latest developmental branch URL in docs --- docs/source/index.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 7edc560e2e..a79a10de12 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -13,7 +13,9 @@ OpenMC was originally developed by members of the `Computational Reactor Physics Group`_ at the `Massachusetts Institute of Technology`_ starting in 2011. Various universities, laboratories, and other organizations now contribute to the development of OpenMC. For more information on OpenMC, feel -free to send a message to the User's Group `mailing list`_. Documentation for the latest version of the develop branch can be found on `Read the Docs`_. +free to send a message to the User's Group `mailing list`_. Documentation for +the latest developmental version of the develop branch can be found on +`Read the Docs`_. .. _Computational Reactor Physics Group: http://crpg.mit.edu .. _Massachusetts Institute of Technology: http://web.mit.edu