Merge branch '79-add-jupyter-notebooks-to-sphinx-documentation' into 'master'

Resolve "Add Jupyter Notebooks to Sphinx documentation" Closes #79 See merge request !57

Merge branch '79-add-jupyter-notebooks-to-sphinx-documentation' into 'master'
Resolve "Add Jupyter Notebooks to Sphinx documentation" Closes #79 See merge request !57
11b491dc · snuverink_j · 66dda059 · 2ccb317e · 11b491dc · 66dda059
Commit 11b491dc authored 5 years ago by snuverink_j
--- a/LICENSES/nbsphinx/LICENSE
+++ b/LICENSES/nbsphinx/LICENSE
+Copyright (c) 2015-2020 Matthias Geier
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
--- a/doc/add_new_files_to_doc.sh
+++ b/doc/add_new_files_to_doc.sh
-#!/usr/bin/env bash
-sphinx-apidoc ../ -o source/
--- a/doc/source/Cyclotron.ipynb
+++ b/doc/source/Cyclotron.ipynb
+../../opal/test/Cyclotron.ipynb
\ No newline at end of file
--- a/doc/source/FODO
+++ b/doc/source/FODO
+../../opal/test/FODO
\ No newline at end of file
--- a/doc/source/FODO.ipynb
+++ b/doc/source/FODO.ipynb
+../../opal/test/FODO.ipynb
\ No newline at end of file
--- a/doc/source/Gantry2
+++ b/doc/source/Gantry2
+../../opal/test/Gantry2
\ No newline at end of file
--- a/doc/source/Gantry2.ipynb
+++ b/doc/source/Gantry2.ipynb
+../../opal/test/Gantry2.ipynb
\ No newline at end of file
--- a/doc/source/Logger.ipynb
+++ b/doc/source/Logger.ipynb
+../../opal/test/Logger.ipynb
\ No newline at end of file
--- a/doc/source/Optimizer.ipynb
+++ b/doc/source/Optimizer.ipynb
+../../opal/test/Optimizer.ipynb
\ No newline at end of file
--- a/doc/source/Probe.ipynb
+++ b/doc/source/Probe.ipynb
+../../opal/test/Probe.ipynb
\ No newline at end of file
--- a/doc/source/ProbePeak.ipynb
+++ b/doc/source/ProbePeak.ipynb
+../../opal/test/ProbePeak.ipynb
\ No newline at end of file
--- a/doc/source/RingCyclotron
+++ b/doc/source/RingCyclotron
+../../opal/test/RingCyclotron
\ No newline at end of file
--- a/doc/source/RingCyclotron.ipynb
+++ b/doc/source/RingCyclotron.ipynb
+../../opal/test/RingCyclotron.ipynb
\ No newline at end of file
--- a/doc/source/RingMultiBunch
+++ b/doc/source/RingMultiBunch
+../../opal/test/RingMultiBunch
\ No newline at end of file
--- a/doc/source/RingMultiBunch.ipynb
+++ b/doc/source/RingMultiBunch.ipynb
+../../opal/test/RingMultiBunch.ipynb
\ No newline at end of file
--- a/doc/source/Sampler.ipynb
+++ b/doc/source/Sampler.ipynb
+../../opal/test/Sampler.ipynb
\ No newline at end of file
--- a/doc/source/StatWrapper.ipynb
+++ b/doc/source/StatWrapper.ipynb
+../../opal/test/StatWrapper.ipynb
\ No newline at end of file
--- a/doc/source/Styles.ipynb
+++ b/doc/source/Styles.ipynb
+../../opal/test/Styles.ipynb
\ No newline at end of file
--- a/doc/source/amr
+++ b/doc/source/amr
+../../opal/test/amr
\ No newline at end of file
--- a/doc/source/amr.rst
+++ b/doc/source/amr.rst
 amr package
 ===========

-Submodules
----------
-
 amr.AmrOpal module
 ------------------